OpenAPI

01Файл

Это стандартный файл OpenAPI 3.1. Он описывает пять методов, формат тел запросов и ответов и схему авторизации.

02Что в файле

Показаны основные коды ответа, полный список — в разделе «Коды ошибок». Вебхуки в файл не входят: адрес для них вы указываете в запросе генерации, а формат события описан в разделе «Вебхуки».

03Как использовать

1. Откройте файл в Postman или Insomnia

   В приложении выберите «Import», вставьте ссылку на файл или перетащите скачанный openapi.json. Методы появятся группой: останется добавить ключ в авторизацию.

2. Создайте клиент для своего языка

   Любой генератор, который понимает OpenAPI 3.1, подойдёт. Например, типы для TypeScript:

   TypeScriptКопировать

   npx openapi-typescript openapi.json -o rendergrid.d.ts

   Клиент для Python (нужна Java):

   PythonКопировать

   npx @openapitools/openapi-generator-cli generate \
     -i openapi.json -g python -o ./rendergrid-client

3. Проверьте ответ живым запросом

   Файл описывает поля и коды, но не заменяет проверку. Отправьте один запрос из быстрого старта и сравните ответ с описанием.

04Авторизация

В файле описаны две схемы, и обе принимают один и тот же ключ:

Где взять ключ и как его беречь — в разделе «Ключи и вход».

05Версия и изменения

Версия API — часть адреса: /api/public/v1. В рамках версии в ответах могут появляться новые поля и новые коды ошибок, поэтому разбирайте ответ терпимо: игнорируйте незнакомые поля, а незнакомый код обрабатывайте по его типу.

Что изменилось и когда — на странице «Что нового».

FAQЧастые вопросы