OpenAPI и Postman
| Файл | Формат |
|---|---|
| https://avantpay.io/developers/openapi.json | OpenAPI 3.1, JSON |
| https://avantpay.io/developers/postman.json | Коллекция Postman v2.1 |
Оба файла собираются из справочника API при каждом обновлении документации и совпадают с ним: те же методы, поля, ошибки и примеры.
OpenAPI
Методы платежей, способов оплаты и возвратов, схемы объектов, ошибки и уведомления (webhooks). Файл подходит для генераторов клиентов и просмотрщиков OpenAPI.
- Адрес сервера —
https://api.avantpay.io, пути — с версией:/v3/payments. - Аутентификация — HTTP Basic (
basicAuth): логин — ID магазина, пароль — секретный ключ. operationIdметода — якорь его раздела в справочнике:create_payment— Создать платёж.
Postman
- В Postman нажмите Import и вставьте адрес https://avantpay.io/developers/postman.json.
- В переменных коллекции (Variables) впишите ID магазина и секретный ключ (где их взять).
| Переменная | Что в ней |
|---|---|
baseUrl | Адрес API без версии: https://api.avantpay.io. |
shopId | ID магазина — логин HTTP Basic. В файле пустая. |
secretKey | Секретный ключ — пароль HTTP Basic. В файле пустая. |
Запросы выполняются в рабочем API: тестового режима нет. Ключи проверяет запрос «Список платежей» — он ничего не меняет.
Заголовок Idempotence-Key в POST-запросах — {{$guid}}: при каждой отправке Postman подставляет новый UUID, и каждая отправка создаёт новый платёж, способ оплаты или возврат.