TrustService API

REST API · v1

TrustService API v1

API を使用して、サービスの一覧表示、注文の作成、SMS の確認、待機中の注文のキャンセル、残高の読み取りを行います。アカウントで API アクセスを有効にし、URL ではなくリクエスト ヘッダーでキーを送信します。

API キー

API v1 は JSON を返し、ユーザーごとに 1 分あたり最大 60 件のリクエストを許可します。

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

リスト サービス

country パラメーターはオプションです。各結果には ID、国、名前、顧客価格、通貨が含まれます。

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

可能なステータスは、待機中完了、および closed です。 SMS が到着すると、message フィールドにそのテキストが含まれます。

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 のレート制限を超えています。