locator(ロケータ)

スパイラルAPIを利用するにあたっては、まずどのAPIサーバにリクエストを実行するかを特定するために、ロケータAPIを使ってURLを取得する必要があります。

locator

locator/apiserver

アクセスすべきAPIサーバのURLを返します。また、サポートしているAPIバージョンを返します。

URL (エンドポイント)

http://www.pi-pe.co.jp/api/locator または https://www.pi-pe.co.jp/api/locator

リクエストパラメータ

パラメータ 必須 説明 文字種長
spiral_api_token APIトークン 半角英数字

レスポンス

パラメータ 説明 文字種長
code 応答コード int 0以上1000未満
message 応答メッセージ 半角英数字記号
location 指定システムのAPIサーバURL URL仕様
default_version デフォルトのAPIバージョン int
supported_version (複数行) 対応しているAPIバージョン (配列) int
use_client_crt スパイラルの操作画面でクライアント認証を必要とするか。管理者、担当者、マルチアカウントのどれか1つでもクライアント認証を使用していればtとなる。 boolean (t or f)