アカウント内API
最終更新日:2019年07月31日
概要
アカウント内APIはスパイラルアカウント内のPHPに対応したページであれば、APIトークンとトークンシークレットおよび$SPIRALオブジェクトを記載せずにAPIを動作させることが可能です。
APIトークン等を明示的に記載しなくて済むため、他アカウントへのアプリインポート時などに発生する不要なソース編集やAPIトークンとトークンシークレットが外部に漏れてしまう懸念などが軽減されます。
スパイラルアカウント内から内部呼び出しでAPIをリクエストする場合は、アカウント内APIを利用することを推奨します。
※ご利用する場合は、管理画面からアカウント内APIの設定を「ON」にしていただく必要があります。
1.アカウント内API の設定を「ON」に変更
「開発」＞「スパイラルAPI」をクリックします。
アカウント内APIの設定状態が「OFF」であることを確認し、「変更」をクリックします。
変更内容および注意事項にご同意の上、「変更」ボタンをクリックします。
※個人情報閲覧不可IDを契約している場合は注意事項の部分へ契約の有無を記載した文言も表示されます。
アカウント内APIの設定を「ON」にする前にご利用中のアカウントで個人情報閲覧不可IDを契約しているのか確認が可能です。
変更が完了したことをご確認いただき、「閉じる」ボタンをクリックし画面を閉じます。
変更内容はトップページからご確認いただけます。
2.アカウント内API の設定を「OFF」に変更
アカウント内APIの設定状態が「ON」であることを確認し、「変更」をクリックします。
変更内容および注意事項にご同意の上、「変更」ボタンをクリックします。
変更が完了したことをご確認いただき、「閉じる」ボタンをクリックし画面を閉じます。
変更内容はトップページからご確認いただけます。
3.アカウント内API利用時の注意点
- アカウント内APIを利用した場合、リクエスト数は契約しているAPIリクエストに含まれます。
- 設定をOFFにした場合、アカウント内APIを利用しているフォームおよびアプリが動作しなくなります。
設定を変更する前に既存のフォームおよびアプリにて利用されていないかご確認の上ご変更下さい。 - アカウント内API を利用してAPIリクエストを実行できるのはアカウント内のみです。
別のスパイラルアカウントに対してリクエストを行う際にはご利用いただけません。 - アカウント内APIではcURLライブラリを使うことはできません。
- アカウント内APIは個人情報閲覧不可IDでのご利用が可能です。
APIの記載方法によっては個人情報閲覧不可IDでもDB内のデータが取得できる可能性等があるため、ご利用については十分にご注意ください。