｜ver.1サポートサイト

HOMEAPIAPIリファレンスの読み方

SPIRAL ver.1のみで使用できる機能はver.1機能 と表示しています。
本文中の画像は、SPIRAL ver.1 の操作画面を主に掲載しております。SPIRAL PLUS と表示が異なる場合は、読み替えてご確認ください。

SPIRAL PLUS

SPIRAL ver.1


APIリファレンスの読み方

最終更新日:2026年10月09日

1. ページの構成

SPIRAL PLUS APIリファレンス および SPIRAL ver.1 APIリファレンスは以下で構成されます。

  1. メソッド一覧
  2. 各メソッドのヘッダーおよびパラメータ
    1. メソッドの説明
    2. リクエストに含めるヘッダーと本体に含めるパラメータ
    3. 成功時のレスポンスおよび失敗時のレスポンス
  3. サンプル

2. 使い方

APIタイプの表記

メソッド一覧にて、各メソッドの前のアイコンはAPIタイプを表しています。

ローレベルAPI

ハイレベルAPI

オープンAPI

その他

APIタイプの説明は「7.APIタイプ」をご覧ください。

第2、第3パラメータの見方

各メソッドのヘッダーおよびパラメータにて、初期表示では、第1パラメータが表示されています。
メソッドによっては、第2、第3パラメータまであります。 第2、第3パラメータがある場合、第1パラメータの右に「>」が表示されていますので、「>」を クリックして展開してください。

例

展開前

展開後

関連ページ