mirror of
https://git.yoomoney.ru/scm/sdk/yookassa-sdk-php.git
synced 2026-08-21 03:30:42 +00:00
Антон Н. Николаев
6.6 KiB
6.6 KiB
YooKassa API SDK
Interface: ApiClientInterface
Namespace: \YooKassa\Client
Summary:
Interface ApiClientInterface.
Constants
- No constants found
Methods
| Visibility | Name | Flag | Summary |
|---|---|---|---|
| public | call() | Создает CURL запрос, получает и возвращает обработанный ответ | |
| public | getUserAgent() | Возвращает UserAgent. | |
| public | setAdvancedCurlOptions() | Устанавливает дополнительные настройки curl. | |
| public | setBearerToken() | Устанавливает OAuth-токен магазина. | |
| public | setConfig() | Устанавливает настройки. | |
| public | setLogger() | Устанавливает объект для логирования. | |
| public | setShopId() | Устанавливает shopId магазина. | |
| public | setShopPassword() | Устанавливает секретный ключ магазина. |
Details
- File: lib/Client/ApiClientInterface.php
- Package: \YooKassa
- See Also:
Tags
| Tag | Version | Description |
|---|---|---|
| category | Interface | |
| author | cms@yoomoney.ru |
Methods
public call() : \YooKassa\Common\ResponseObject
public call(string $path, string $method, array $queryParams, null|string $httpBody = null, array $headers = []) : \YooKassa\Common\ResponseObject
Summary
Создает CURL запрос, получает и возвращает обработанный ответ
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
string |
path | URL запроса |
string |
method | HTTP метод |
array |
queryParams | Массив GET параметров запроса |
null OR string |
httpBody | Тело запроса |
array |
headers | Массив заголовков запроса |
Returns: \YooKassa\Common\ResponseObject -
public setLogger() : mixed
public setLogger(null|\Psr\Log\LoggerInterface $logger) : mixed
Summary
Устанавливает объект для логирования.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
null OR \Psr\Log\LoggerInterface |
logger | Объект для логирования |
Returns: mixed -
public getUserAgent() : \YooKassa\Client\UserAgent
public getUserAgent() : \YooKassa\Client\UserAgent
Summary
Возвращает UserAgent.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Returns: \YooKassa\Client\UserAgent -
public setShopId() : mixed
public setShopId(int|string|null $shopId) : mixed
Summary
Устанавливает shopId магазина.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
int OR string OR null |
shopId | shopId магазина |
Returns: mixed -
public setShopPassword() : mixed
public setShopPassword(?string $shopPassword) : mixed
Summary
Устанавливает секретный ключ магазина.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
?string |
shopPassword |
Returns: mixed -
public setBearerToken() : mixed
public setBearerToken(?string $bearerToken) : mixed
Summary
Устанавливает OAuth-токен магазина.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
?string |
bearerToken |
Returns: mixed -
public setConfig() : mixed
public setConfig(array $config) : mixed
Summary
Устанавливает настройки.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Parameters:
| Type | Name | Description |
|---|---|---|
array |
config |
Returns: mixed -
public setAdvancedCurlOptions() : void
public setAdvancedCurlOptions() : void
Summary
Устанавливает дополнительные настройки curl.
Details:
- Inherited From: \YooKassa\Client\ApiClientInterface
Returns: void -
Top Namespaces
Reports
This document was automatically generated from source code comments on 2025-07-01 using phpDocumentor
© 2025 YooMoney