impact-factoring/accounts-client

A Laravel client for consuming Impact Factoring Accounts API

1.2.0 2025-03-14 09:34 UTC

Requires

• illuminate/cookie: ^11.7
• illuminate/http: ^11.7
• illuminate/support: ^11.0

Requires (Dev)

• orchestra/testbench: ^9.9
• phpunit/phpunit: ^11.5

MIT

• Daniel van der Wal

README

Installation

composer require impact-factoring/accounts-client

Methods

__construct(string $baseUrl)

Constructor method to initialize the client with the base URL.

• Parameters:
  • $baseUrl (string): The base URL for the API.

login(array $credentials): ?array

Logs a user into the system using provided credentials.

• Parameters:

  • $credentials (array): An array containing user credentials.

• Returns:

  • null|array: Returns user data if login is successful, null otherwise.

logout(?string $token = null): ?bool

Logs out a user from the system.

• Parameters:

  • $token (string|null): Optional. The authentication token of the user.

• Returns:

  • null|bool: Returns true if logout is successful, false otherwise.

authenticate(?string $token): bool

Authenticates a user token.

• Parameters:

  • $token (string|null): Optional. The authentication token of the user.

• Returns:

  • bool: Returns true if authentication is successful, false otherwise.

getUserByToken(?int $userId = null, ?string $token = null): ?array

Fetches user data using provided user ID and token.

• Parameters:

  • $userId (int|null): Optional. The ID of the user.
  • $token (string|null): Optional. The authentication token of the user.

• Returns:

  • null|array: Returns user data if retrieval is successful, null otherwise.