APIトークン
最終更新日:2023年01月14日
1.APIトークン一覧画面
「開発」>「スパイラルAPI」をクリックします。
「APIトークン」をクリックします。
※「※トークン一覧はこちら」からもご確認いただけます。
今まで発行したトークンの一覧が表示されます。
2.APIトークン詳細
「APIトークン一覧」から詳細を見るトークンのタイトルをクリックします。
トークン詳細画面が表示されます。
(1)タイトル
APIのトークンタイトルおよびトークン情報が表示されます。
(2)ステータス
トークンの利用可否状態を表示します。
「有効」:APIを動作させることができます。
「無効」:APIを動作させることはできません。
(3)APIタイプ制限
利用するAPIのタイプを制限することが可能です。
「利用する」を選択した場合には利用可能APIタイプでリクエスト可能なメソッドのレベルを表示します。
(4)利用可能APIタイプ
リクエスト可能なメソッドのレベルを「ハイレベル」「ローレベル」「オープン」から選択可能です。
「ハイレベル」を選択した場合は「許可するマイエリア」を指定する必要があります。
(5)IPアドレス制限
接続を許可するIPアドレスを追加をすることが可能です。
※IPアドレス制限にて「制限する」に設定した場合、接続を許可するIPアドレスにスパイラル内部で利用するIPアドレスが追加されるため
フォームやマイエリアなどスパイラル内部からのリクエストは制限されません。
3.APIトークン新規作成
「APIトークン一覧」の「トークン発行」をクリックします。
タイトル、ステータス、APIタイプ制限、必要に応じてIPアドレス制限を設定し、「発行する」ボタンをクリックします。
タイトルには、任意の文字列を指定いただいてかまいません。なお、一度トークンを削除した後に、再度トークンを発行する際に同じタイトルを指定すると同じトークンが発行されます。
発行が完了した旨を記載したライトボックスが表示されます。
発行したトークンは「一覧へ戻る」からご確認いただけます。
4.APIトークン削除
1.トークン一覧から削除する場合
「トークン一覧」の右側歯車のマークから「削除」をクリックします。
確認のポップアップが表示されます。問題がなければ「削除」ボタンをクリックします。
※削除後、再度トークンを発行する際に同じタイトルを指定すると同じトークンを発行することができます。
2.トークン詳細から削除する場合
「トークン一覧」から削除を行うトークンタイトルを選択し詳細ページへ遷移します。
詳細画面の左下「削除」ボタンをクリックします。
確認のポップアップが表示されます。問題がなければ「削除」ボタンをクリックします。
※削除後、再度トークンを発行する際に同じタイトルを指定すると同じトークンを発行することができます。
5.注意事項
- 2022年以降、SSL通信推奨のため、非SSLでのリクエストはできなくなります。
- APIトークンおよびトークンシークレットはDB内のデータにアクセスできる重要な情報です。
不要なAPIトークンは無効化する、または削除するようにしましょう。 - 誤ってAPIトークンを削除した場合、再度トークンを発行する際に同じタイトルを指定すると同じトークンを発行することができます。
- 「利用可能APIタイプ:ハイレベル」について、許可するマイエリアが共有設定されている場合、マイエリア設定は親マイエリアに依存するため、子マイエリアは選択できません。
許可するマイエリアへ親マイエリアを設定するようにしてください。