Спецификация 3.1

Файл /openapi.json содержит все семь операций v1, схему Bearer-авторизации, тела запросов и модели ответов. servers.url содержит полный адрес https://luffysms.com/api/v1, поэтому скачанный файл можно импортировать без восстановления домена.

Postman и Insomnia

• Скачайте OpenAPI и импортируйте файл как API-спецификацию.
• Проверьте базовый URL https://luffysms.com/api/v1 и сохраните Bearer-ключ в приватных переменных окружения.
• Проверьте /balance до запуска операций покупки.
• Для покупки вручную задайте сохранённый Idempotency-Key. Не генерируйте его заново в pre-request script при каждом повторе.

Генерация TypeScript-типов

openapi-typescript — сторонний инструмент, не SDK Luffy SMS. Он создаёт типы, но не выполняет запросы и не реализует retry или идемпотентность. Зафиксируйте проверенную версию инструмента в своём проекте.

npx openapi-typescript https://luffysms.com/openapi.json \
  -o ./src/luffy-api.d.ts

Обновление контракта

Версия API в пути — v1, версия спецификации — 1.0.0. Сравнивайте скачанный контракт с предыдущим в CI. Толерантно обрабатывайте новые поля ответов, но неизвестный статус заказа не считайте успешным завершением.