> For the complete documentation index, see [llms.txt](https://docs.iexexchanger.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.iexexchanger.com/exchanger-api/api-reference/openapi-reference.md).

# Как читать 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 и создание заявки](/exchanger-api/obmen-i-zayavki/quotes-preflight-orders.md) описан сценарий создания заявки.
2. На странице [Exchange API Reference](/exchanger-api/api-reference/exchange.md) можно открыть точный endpoint `POST /private/exchange/orders`.
3. В [Scopes и права ключа](/exchanger-api/spravochnik/scopes.md) можно проверить, какие права нужны ключу.

## Группы API Reference

| Страница                                                                 | Что смотреть                                                               |
| ------------------------------------------------------------------------ | -------------------------------------------------------------------------- |
| [System](/exchanger-api/api-reference/system.md)                         | Ping, OpenAPI-файл и приватный ping.                                       |
| [Security](/exchanger-api/api-reference/security.md)                     | Список scopes, доступных API-ключу.                                        |
| [Client и Usage](/exchanger-api/api-reference/client-usage.md)           | Проверка ключа, профиль клиента, usage и квоты.                            |
| [Platform contracts и schemas](/exchanger-api/api-reference/platform.md) | Версии контрактов и JSON Schema.                                           |
| [Exchange](/exchanger-api/api-reference/exchange.md)                     | Платежные системы, направления, quote, preflight, создание заявки, статус. |
| [Orders](/exchanger-api/api-reference/orders.md)                         | Список заявок и справочник статусов.                                       |
| [Files](/exchanger-api/api-reference/files.md)                           | Upload intents и загрузка файлов.                                          |
| [Verifications](/exchanger-api/api-reference/verifications.md)           | Требования, identity/card verification и проверки по заявке.               |
| [Webhooks](/exchanger-api/api-reference/webhooks.md)                     | Webhook endpoints, события, доставки, retry.                               |
| [Partner](/exchanger-api/api-reference/partner.md)                       | Партнерская сводка, статистика, рефералы, обмены и выплаты.                |
| [Reviews](/exchanger-api/api-reference/reviews.md)                       | Чтение отзывов и создание отзыва по заявке.                                |
| [Sandbox](/exchanger-api/api-reference/sandbox.md)                       | Тестовая симуляция заявки без реального обмена.                            |

## OpenAPI-файл

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

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

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

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

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