非公開API

Rakuten RapidAPIではAPIの公開・非公開も思いのままです。非公開APIは自分自身、またはチームメンバーや友人など、アクセス許可が付与された開発者だけが見ることができます。


非公開API

Rakuten RapidAPIプラットフォームでは非公開API(内部API)を作成することができます。デフォルトでは、Rakuten RapidAPIで新しくAPIを追加すると、すべて非公開設定になっています。自社のAPIを一般公開したくないプロバイダの方はこちらの設定をご利用ください。

Rakuten RapidAPIは、サンドボックスが必要だったり、特定のクライアントだけにキーを提供したいプロバイダにとって素晴らしいソリューションを提供しています。さらに、自分の非公開APIを安全な環境で開発・テストすることができます。

APIを公開したい場合は、以下の方法で簡単に設定の変更が可能です。

  1. Mashape Marketplace (https://market.mashape.com/dashboard) にログインしてください。
  2. 公開したいAPIの管理設定画面に移動してください(各APIページ右上の「Analytics and Settings(分析情報と設定)」をクリック)。
  3. 左側のメニューから「General(一般)」を選択してください。
  4. 「Visibility(公開範囲)」を「Public(公開)」に切り替えてください。

必要な情報(説明文、ロゴ、名称など)がきちんと入力されていれば、これでAPIはマーケットプレイスで公開されるようになります。

APIに開発者を招待する

APIが非公開の状態だと、開発者はそのAPIの存在を知ることはできません。特定の友人や共同作業者がAPIをテスト、利用、調査できるようにしたい方向けに、Rakuten RapidAPIには招待機能が備わっています。

非公開APIにユーザーを招待するためには、そのユーザーがMashape Marketplaceに登録されている必要があります。

Rakuten RapidAPIの非公開APIにユーザーを招待する手順は以下の通りです。

  1. Mashape Marketplace (https://market.mashape.com/dashboard) にログインしてください。
  2. 招待したい非公開APIのページに移動してください。
  3. 右上の「Analytics and Settings(分析情報と設定)」ボタンをクリックしてください。
  4. 左側のメニューから「Invite Developer(開発者を招待)」を選択してください。
  5. モーダルウィンドウが表示されるので、ユーザー名を入力・検索し、確認してから招待を行ってください。

誤って誰かを追加してしまった場合や、現在APIへのアクセス権を持つユーザーを削除したい場合は、まず左側のメニューから「Developers(開発者)」をクリックしてください。該当のユーザー欄に表示されている下向きの矢印をクリックし、「Block Develop(開発者をブロック)」を選択すれば削除することができます。

手続きはこれで完了です。