Zonos APIをはじめる

注記: Zonosは現在、フル機能サポート付きのGraphQLをプライマリAPIとして使用しています。RESTエンドポイントはレガシー統合向けに限定サポートで維持されています。新規統合ではGraphQL APIをご利用ください。

Zonos REST APIはリソース指向のURLを提供し、JSONエンコードされたレスポンスを返し、フォームエンコードされたリクエスト本文を受け付け、標準のHTTPレスポンスコードと認証を使用します。

Zonos APIへアクセスするにはAPIキーが必要です。同じAPIキーをテストと本番統合の両方で使用します。APIキーはリクエストの認証に使われます。

定期的にAPIへフィールドを追加します。統合後のエラーを防ぐため、未知のフィールドは無視することを推奨します。

認証 

ZonosはAPIキーでAPIアクセスを許可します。新しいZonosアカウントとAPIキーはこちらで登録できます。

APIキーは、次のようなヘッダーですべてのAPIリクエストに含まれます:

serviceToken: meowmeowmeow

注記: meowmeowmeowを自身のAPIキーに置き換えてください。

バージョン 

REST APIバージョンへアクセスするには、zonos-versionヘッダーを送信します。該当し必須の場合は、対応するAPIドキュメントで適切なヘッダー情報を確認してください。

バージョンが指定されない場合、デフォルトは最後にサポートされたバージョンになります。

現在のバージョンヘッダーはzonos-version: 2021-01-01です。