СправочникClasses
Client v1.0.0
HTTP-клиент Guzzle с кэшем GET, ретраями 429/5xx и X-Subuser.
Описание: HTTP-клиент Guzzle с кэшем GET, ретраями 429/5xx и X-Subuser.
Namespace: Devcraft\Webshare\Classes
Extends: AbstractBasicClass
С версии: 1.0.0
См. также:
Методы
__construct(): void
Описание: Создать HTTP-клиент с Token-авторизацией.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$apiKey | string | API ключ. Если не указан — из API_KEY. |
$apiUrl | string | — |
$apiVersion | string | Override версии API для этого вызова. |
$httpClient | ?GuzzleClient | Опциональный Guzzle client (тесты/DI). По умолчанию: NULL. |
Возвращает: void
withSubuser(): self
Описание: Установить X-Subuser для последующих запросов.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$subuserId | ?string | ID SubUser для заголовка X-Subuser. |
Возвращает: self
getSubuser(): ?string
Описание: Текущий SubUser id для маскировки.
Возвращает: ?string
send(): string
Описание: Отправить запрос к WebShare API.
Параметры:
| Параметр | Тип | Описание |
|---|---|---|
$endpoint | string | Относительный путь ресурса. |
$method | RequestMethod | HTTP-метод. По умолчанию: RequestMethod::GET. |
$query | ?QueryBuilder | QueryBuilder query-параметров. По умолчанию: NULL. |
$body | ?RequestBody | Тело запроса. По умолчанию: NULL. |
$forceRefresh | bool | Обойти кэш GET. По умолчанию: false. |
Возвращает: string
Исключения: ApiException, RateLimitException, JsonException
getRateLimits(): array
Описание: Последние x-ratelimit-* заголовки.
Возвращает: array
getApiVersion(): string
Описание: Версия API этого клиента.
Возвращает: string