Download the PHP package blueink/blueink-client-php without Composer

BlueInk API Client

A PHP client to interact with the BlueInk REST API. For an overview of the API, see the API v2 Documentation.

This client library relies on guzzle and snorlax, under the hood.

Getting Started

Error Handling and Exceptions

Requests raise exceptions if an error is encountered. This includes networking errors (connection timeout, DNS errors, etc), server errors (5XX status codes), and application-level errors (4XX status codes).

See documentation on Guzzle exceptions

All exceptions extend from GuzzleHttp\Exception\TransferException.

You can handle specific classes of errors as follows:

All exceptions are in the namespace GuzzleHttp\Exception.

• 4XX errors: ClientException
• 5XX errors: ServerException
• Networking errors: ConnectException
• Too many redirects: TooManyRedirectsException

Or catch multiple classes of exceptions:

• BadResponseException: 4XX and 5XX
• RequestException: 4XX, 5XX and networking errors
• TransferException: All errors that can be thrown during a request / response

Handle Multiple Errors by Catching a RequestException

Handle Different Error Types Individually

Pagination

API operations that return lists of data (e.g. /bundles/, /persons/) are paginated.

Code Conventions

We use the following naming conventions in this code base:

• ClassName
• methodName
• propertyName
• function_name (meant for global functions)
• $variable_name
• CONSTANT_NAME (created with define(...))