Download the PHP package affiliateforge/php-admitad-api without Composer
On this page you can find all versions of the php package affiliateforge/php-admitad-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download affiliateforge/php-admitad-api
More information about affiliateforge/php-admitad-api
Files in affiliateforge/php-admitad-api
Package php-admitad-api
Short Description Provides Admitad API
License MIT
Informations about the package php-admitad-api
php-admitad-api
The package provides Admitad API Client.
Requirements
php ^8.1
- any implementation for PSR-18
Client Interface
. For example,symfony/http-client
Installation
composer require affiliateforge/php-admitad-api
Usage
Example
For example, to get a list of coupons for a website, you first need to get an authorization token, and then use your token to get a list of coupons. The code for these requests will look like this
Description
The package provides DTO objects for each (not yet) endpoint in the API. These DTO objects are distributed by namespace in accordance with their description in the documentation.
Each such DTO accepts in the constructor all the parameters that the endpoint can accept (from the documentation). They will be substituted when the request is executed in the right place (query parameters or the request body). In response, you will receive a DTO that has getters for each response field from the documentation.
To execute a request, you must create an DTO object and pass it to the Affiliateforge\PhpAdmitadApi\APIClient
class in the doRequest(CommandDTO $command, array $headers = []): ResponseDTO
.
Many API endpoints require a token to be specified in the authorization headers. Headers are passed in the $headers
parameter of the doRequest
method.
To receive a token, you should use the DTO Affiliateforge\PhpAdmitadApi\Api\Endpoints\ClientAuthorization\GetToken
.
In the constructor you should specify the clientID
and the requested scopes.
In response, you will receive a DTO for this endpoint, from which you can receive the token itself.
Then, you must pass this token in the Authorization
header for every request for other endpoints.
APIClient Configuration
You can pass any implementation of the PSR-18 Client Interface
when creating a APIClient
object. If no implementation is passed, the package will try to find one in your dependencies using the package php-http/discovery
.