The Context Dev PHP library provides convenient access to the Context Dev REST API from any PHP 8.1.0+ application.
It is generated with Stainless.
The REST API documentation can be found on docs.context.dev.
composer require "context-dev/context-dev-php 2.13.0"
This library uses named parameters to specify optional arguments. Parameters with a default value must be set by name.
<?phpuseContextDev\Client;
$client = newClient(apiKey: getenv('CONTEXT_DEV_API_KEY') ?: 'My API Key');
$brand = $client->brand->retrieve(domain: 'REPLACE_ME', type: 'by_domain');
var_dump($brand->cache_metadata);It is recommended to use the static with constructor Dog::with(name: "Joey")
and named parameters to initialize value objects.
However, builders are also provided (new Dog)->withName("Joey").
When the library is unable to connect to the API, or if the API returns a non-success status code (i.e., 4xx or 5xx response), a subclass of ContextDev\Core\Exceptions\APIException will be thrown:
<?phpuseContextDev\Core\Exceptions\APIConnectionException;
useContextDev\Core\Exceptions\RateLimitException;
useContextDev\Core\Exceptions\APIStatusException;
try {
$brand = $client->brand->retrieve(domain: 'REPLACE_ME', type: 'by_domain');
} catch (APIConnectionException$e) {
echo"The server could not be reached", PHP_EOL;
var_dump($e->getPrevious());
} catch (RateLimitException$e) {
echo"A 429 status code was received; we should back off a bit.", PHP_EOL;
} catch (APIStatusException$e) {
echo"Another non-200-range status code was received", PHP_EOL;
echo$e->getMessage();
}Error codes are as follows:
| Cause | Error Type |
|---|---|
| HTTP 400 | BadRequestException |
| HTTP 401 | AuthenticationException |
| HTTP 403 | PermissionDeniedException |
| HTTP 404 | NotFoundException |
| HTTP 409 | ConflictException |
| HTTP 422 | UnprocessableEntityException |
| HTTP 429 | RateLimitException |
| HTTP >= 500 | InternalServerException |
| Other HTTP error | APIStatusException |
| Timeout | APITimeoutException |
| Network error | APIConnectionException |
Certain errors will be automatically retried 2 times by default, with a short exponential backoff.
Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors, and timeouts will all be retried by default.
You can use the maxRetries option to configure or disable this:
<?phpuseContextDev\Client;
// Configure the default for all requests:$client = newClient(requestOptions: ['maxRetries' => 0]);
// Or, configure per-request:$result = $client->brand->retrieve(
domain: 'REPLACE_ME', type: 'by_domain', requestOptions: ['maxRetries' => 5]
);You can send undocumented parameters to any endpoint, and read undocumented response properties, like so:
Note: the extra* parameters of the same name overrides the documented parameters.
<?php$brand = $client->brand->retrieve(
domain: 'REPLACE_ME',
type: 'by_domain',
requestOptions: [
'extraQueryParams' => ['my_query_parameter' => 'value'],
'extraBodyParams' => ['my_body_parameter' => 'value'],
'extraHeaders' => ['my-header' => 'value'],
],
);If you want to explicitly send an extra param, you can do so with the extra_query, extra_body, and extra_headers under the request_options: parameter when making a request, as seen in the examples above.
To make requests to undocumented endpoints while retaining the benefit of auth, retries, and so on, you can make requests using client.request, like so:
<?php$response = $client->request(
method: "post",
path: '/undocumented/endpoint',
query: ['dog' => 'woof'],
headers: ['useful-header' => 'interesting-value'],
body: ['hello' => 'world']
);This package follows SemVer conventions. As the library is in initial development and has a major version of 0, APIs may change at any time.
This package considers improvements to the (non-runtime) PHPDoc type definitions to be non-breaking changes.
PHP 8.1.0 or higher.