Как читать API Reference

API Reference построен из файла:

openapi/openapi.yaml

Это точный контракт API: endpoints, параметры, request body, headers, responses, security и схемы данных.

Когда открывать API Reference

Открывайте API Reference, когда нужно узнать:

• какой HTTP method использовать;
• какой path у endpoint;
• какие query parameters доступны;
• какие поля передавать в JSON body;
• какие headers нужны;
• какой scope требуется ключу;
• какие ответы может вернуть API.

Как пользоваться вместе с руководствами

Руководства показывают порядок действий. API Reference показывает точные детали запроса.

Пример:

1. В guide Расчет, preflight и создание заявки описан сценарий создания заявки.
2. На странице Exchange API Reference можно открыть точный endpoint POST /private/exchange/orders.
3. В Scopes и права ключа можно проверить, какие права нужны ключу.

Группы API Reference

Страница	Что смотреть
System	Ping, OpenAPI-файл и приватный ping.
Security	Список scopes, доступных API-ключу.
Client и Usage	Проверка ключа, профиль клиента, usage и квоты.
Platform contracts и schemas	Версии контрактов и JSON Schema.
Exchange	Платежные системы, направления, quote, preflight, создание заявки, статус.
Orders	Список заявок и справочник статусов.
Files	Upload intents и загрузка файлов.
Verifications	Требования, identity/card verification и проверки по заявке.
Webhooks	Webhook endpoints, события, доставки, retry.
Partner	Партнерская сводка, статистика, рефералы, обмены и выплаты.
Reviews	Чтение отзывов и создание отзыва по заявке.
Sandbox	Тестовая симуляция заявки без реального обмена.

OpenAPI-файл

Файл можно использовать в инструментах разработчика:

• импортировать в Postman;
• импортировать в Insomnia;
• открыть в Swagger UI;
• использовать для генерации собственного клиента.

Live OpenAPI на установленном обменнике:

https://{your-domain}/api/v3/openapi.yaml

Если вы работаете с конкретным обменником, используйте OpenAPI с его домена, чтобы видеть актуальный контракт именно этой установки.