• 228 направлений
  • Без KYC — всегда
  • Bitcoin, Monero, USDT и ещё 4 валюты

API и интеграция

OpenAPI

OpenAPI — это стандарт машиночитаемого описания REST API: эндпоинтов, параметров, схем и ошибок; на его основе создают типизированные клиентские библиотеки, документацию и коллекции запросов.

Документ OpenAPI в формате YAML или JSON описывает REST API настолько точно, что по нему могут работать программы: серверы, каждый путь и каждую операцию, параметры и тела запросов, схемы ответов для успеха и для каждой ошибки, а также схему аутентификации. Спецификация выросла из Swagger и поддерживается OpenAPI Initiative; в версии 3.1 её схемы приведены в соответствие с JSON Schema.

По одному файлу инструменты могут сгенерировать типизированные клиенты на TypeScript, Python, Java и многих других языках, импортировать API в Postman или Insomnia, проверять запросы и ответы в тестах, запускать mock-серверы, формировать справочную документацию и отмечать несовместимые изменения между версиями. Для небольшого API сгенерированный клиент может полностью заменить официальные SDK, а если файл версионируется вместе с API, клиент автоматически остаётся актуальным. Этот файл — ещё и самый полезный артефакт, который может прочитать ИИ-помощник для программирования, чтобы правильно интегрировать API.

Чего схема не передаёт, так это поведения: когда повторять запросы, как работает идемпотентность, как подписываются вебхуки. Для этого по-прежнему нужна текстовая документация.

Пример

Условная команда генерирует клиент на TypeScript из файла SMS-провайдера. Теперь компилятор отвергает код, в котором пропущено обязательное поле, а тип сообщения показывает, что ответ включает число сегментов и цену, поэтому учёт расходов команда строит на реальных полях, а не на догадках.

Типичные ошибки

  • Сгенерировать клиент один раз и больше никогда его не обновлять, из-за чего он расходится с API.
  • Вручную править сгенерированный код, который следующая генерация перезапишет.
  • Направлять инструменты на устаревшую скачанную копию вместо опубликованного файла.

В SMSMeteor: API описан в OpenAPI 3.1; описание опубликовано по адресу /docs/openapi.yaml и версионируется вместе с API. Примеры, в том числе для cURL, Python, Node, PHP и Go, приведены на странице SDK. Тестовый ключ отвечает так же, как рабочий, но ничего не отправляет и не списывает, поэтому сгенерированный клиент можно полностью проверить ещё до пополнения баланса.

Подробнее

Посмотрите, как это работает на практике.Для регистрации достаточно адреса электронной почты. Таблица тарифов открыта, оплата принимается в криптовалюте, тестовый ключ бесплатный.
Начать отправку