API TrustService

REST API · v1

TrustService API v1

Використовуйте API, щоб отримати список послуг, створити замовлення, перевірити наявність SMS, скасувати замовлення, що очікує, і переглянути баланс. Увімкніть доступ через API у своєму обліковому записі та надішліть ключ у заголовку запиту, а не в URL-адресі.

Ваш ключ API

API v1 повертає JSON і дозволяє до 60 запитів на хвилину для кожного користувача.

X-API-Key: YOUR_API_KEY
Authorization: Bearer YOUR_API_KEY
GET/api/v1/services

Список служб

Параметр country необов’язковий. Кожен результат містить ідентифікатор, країну, назву, ціну клієнта та валюту.

https://trustservice.io/api/v1/services?country=US
POST/api/v1/orders

Створення замовлення

TrustService автоматично обирає найкращий доступний номер для вашого запиту. Якщо перший варіант недоступний, система одразу перевіряє наступний за тією самою показаною ціною. Повторювати замовлення вручну не потрібно.

Content-Type: application/json

{"service_id": 123}
GET/api/v1/orders/{id}

Статус замовлення та SMS

Можливі статуси: очікування, завершено та закрито. Після надходження SMS поле повідомлення містить його текст.

https://trustservice.io/api/v1/orders/{order_id}
POST/api/v1/orders/{id}/cancel

Скасувати замовлення

https://trustservice.io/api/v1/orders/{order_id}/cancel
GET/api/v1/balance

Баланс

https://trustservice.io/api/v1/balance
HTTP4xx / 5xx

Помилки

API використовує стандартні коди HTTP: 401 недійсний або вимкнений ключ, 402 недостатній баланс, 404 замовлення не знайдено, Помилка замовлення або скасування 409, недійсна служба 422 і перевищено ліміт швидкості 429.