Developers User Guide
新たに開発者ポータルに登録したユーザーは「アプリケーション」を作成できます。
「アプリケーション」とは、ユーザーが開発しようとする実際のアプリケーションを指します。ユーザーは、そのアプリケーション内で使用するためのAPIをリクエストし、受け取ります。共同開発のためにメンバーを追加することもできます。ユーザーは、自分が所属するアプリケーションにのみアクセスできます。
自分のアプリケーションを作成する
アプリケーション -> マイアプリケーション -> 作成ボタンをクリック -> アプリケーションの名前を入力します。
アプリケーション基本情報画面
この画面では、以下の機能が提供されます：
- アプリケーション名の編集
- アプリケーションアイコンの挿入
- アプリケーションの削除
アプリケーションAPIキー画面
この画面では、セキュリティ目的のためにAPIキーが表示されます。APIキーが外部の第三者に誤って公開された場合、セキュリティを維持するためにAPIキーを再生成することができます。
APIキーを再生成する際、古いAPIキーを使用しているシステムで、既存のキーの有効期限切れや認証失敗などのエラーが発生する可能性があるため、変更には注意が必要です。
API使用のリクエスト
ユーザーはこの画面でAPIの使用を管理できます。ユーザーは、APIの使用が管理者によって承認または拒否されたかを確認できます。追加ボタンをクリックすると、使用可能なAPIアイテムが表示されます。
これは管理者によって登録されたAPIのリストです。APIを選択し、目的を入力した後、確認ボタンをクリックして管理者に承認リクエストを送信します。
APIの使用をリクエストした後、ステータスは管理者が承認するまで「保留中」と表示されます。承認されると、ステータスは「完了」に変更され、APIのURLが表示され、使用可能になります。
赤いバツボタンをクリックすると、APIを削除することを確認するプロンプトが表示されます。ドキュメントアイコンをクリックすると、APIドキュメントページが開きます。
メンバー管理
アプリケーションのメンバーを確認できます。
- アプリを削除
- アプリの基本情報を変更
- アプリのAPIキーを更新
- 新しいアプリのAPIエンドポイントをリクエスト/削除
- アプリのメンバーを追加し、権限を付与
検索ボタンをクリックすると、モーダルが開き、新しいメンバーを選択してアプリケーションに追加できます。
新しいメンバーを追加した後、メンバーにAdministratorの権限を付与するためにチェックボックスをクリックします。管理者権限を削除するにはチェックを外すか、赤いバツボタンをクリックしてメンバーをアプリケーションから削除します。
IP/リファラーホワイトリスト管理
ユーザーは、アプリケーション内のAPIと通信する際にアクセスを許可される「IP」または「リファラーURL」のリストを登録できます。
ユーザーはIP/リファラーのボタンをクリックして、2つのパネル間を切り替え、それぞれの項目を個別に設定できます。
ユーザーは「新しいIP/リファラーを追加」をクリックして新しいアイテムを作成し、IPv4 CIDRまたはURLを入力し、アクティブチェックボックスをオンにしてホワイトリストを有効にすることができます。ユーザーはチェックを外して無効にするか、「削除」ボタンをクリックしてホワイトリストに登録されたアイテムを削除できます。