Коллекции Postman и Insomnia
Коллекция содержит все методы, доступные ключу интеграции, сгруппированные по тем же
разделам, что и список маршрутов ключа. Авторизация настроена
на Bearer {{access_token}}, адрес сервера вынесен в переменную baseUrl. Для асинхронных
методов заголовок Billz-Response-Channel: HTTP уже проставлен. Необязательные заголовки
без значения по умолчанию, например accept-language, выключены: включите и задайте
значение, если они нужны.
Файл: billz-api.postman_collection.json (формат Postman Collection v2.1, читается и Postman, и Insomnia).
Переменные
Заголовок раздела «Переменные»| Переменная | Значение |
|---|---|
baseUrl |
https://api-admin.billz.ai |
secret_token |
ключ интеграции — единственная переменная, которую нужно заполнить руками |
access_token |
заполняется автоматически запросом Получение токена доступа |
refresh_token |
заполняется автоматически, используется запросом Обновление токена доступа |
Как получить токен
Заголовок раздела «Как получить токен»- Заполнить переменную
secret_tokenключом интеграции. - Выполнить Получение токена доступа (
POST /v1/auth/login) в разделе «Аутентификация». Скрипт запроса сохранитaccess_tokenиrefresh_tokenиз ответа в переменные коллекции. - Дальше все запросы коллекции авторизованы. Когда
access_tokenистечёт, выполнить Обновление токена доступа (POST /v2/auth/refresh): тело запроса берётrefresh_tokenиз переменной, скрипт обновит обе переменные.
Пока access_token пуст, запросы уходят без заголовка Authorization, и API отвечает
401 UNAUTHORIZED.
Postman
Заголовок раздела «Postman»- Import → Upload Files, выбрать файл коллекции.
- Открыть коллекцию → вкладка Variables → заполнить Current value переменной
secret_token.baseUrlпри необходимости меняется там же. - Выполнить Получение токена доступа — токены появятся в Current value.
Insomnia
Заголовок раздела «Insomnia»- Import → From File, выбрать тот же файл. Insomnia распознаёт формат Postman, включая скрипты запросов.
- Переменные коллекции попадают в базовое окружение коллекции (Manage Environments);
там задаётся
secret_token. - Выполнить Получение токена доступа — скрипт запишет токены в то же окружение.
Обновление
Заголовок раздела «Обновление»Коллекция генерируется из OpenAPI-спецификации и не правится руками: изменилась спецификация — коллекция пересобирается и обновляется в репозитории вместе с ней.