利用手順

Web APIの実行方法を解説します。

Web API接続先

本番環境:web.zmaps-api.com
検証環境:test-web.zmaps-api.com
※リクエストのURL長は8190byteです。
GETにおいて長いリクエストパラメータを与える際はご注意ください。

HTTP Status

正常終了時:200
認証エラー:401
API固有パラメータ指定エラー:400

API実行方法

認証の種類

API実行時に選択できる認証方式は
接続元IPアドレス制限、接続元リファラ制限、OAuth2.0認証の3種類あります。
各認証の有効設定、認証方式の詳細設定、APIキーはコンソールの「チャネル設定」＞「チャネル一覧」＞「チャネル詳細」をご確認ください。
API実行時の認証設定手順は下記のとおりです。

  1. 接続元IPアドレス制限

    リクエストヘッダに、APIキー(x-api-key)、認証を行う方式(Authorization:ip)を設定します。
    ※リクエスト元のIPアドレスによって認証されるため、事前にコンソールのチャネル設定で許可IPを設定してください。

    サンプルリクエストヘッダ
    x-api-key:[APIキー]
Authorization:ip
  2. 接続元リファラ制限

    リクエストヘッダに、APIキー(x-api-key)、認証を行う方式(Authorization:referer)を設定します。
    また、リファラパラメータ(Referer)を付加する必要がある場合は設定してください。
    リファラパラメータは、ブラウザ等からリクエストする場合既に付加されていることがあります。
    ※リクエスト元のリファラによって認証されるため、事前にコンソールのチャネル設定で許可リファラを設定してください。

    サンプルリクエストヘッダ
    x-api-key:[APIキー]
Authorization:referer
Referer:遷移元URL
  3. OAuth2.0認証

    トークン取得APIで取得したトークンをリクエストヘッダに設定します。
    ※OAuth2.0によって認証されるため、事前にコンソールのチャネル設定でOAuth2.0認証を設定してください。

    サンプルリクエストヘッダ
    x-api-key:[APIキー]
Authorization:Bearer [トークン文字列]
API実行

各APIリファレンスを参照しリクエストを作成、実行します。

注意事項

並列でのリクエスト、または重複した連続リクエストはレスポンス速度の悪化やサーバーへの負荷を増大させる恐れがあるためお控えください。
リクエスト制限がございます。詳細はこちらをご覧ください。