スパイラル サポートサイト

powered by SPIRAL PLACE®

HOME > 機能 > スパイラルAPI>locator(ロケータ)

locator(ロケータ)


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


ロケータ


locator/apiserver


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


URL (エンドポイント)


https://www.pi-pe.co.jp/api/locator


リクエストパラメータ


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


レスポンス


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