APIbankサイトご利用方法のご案内

APIbankは「APIを探して、試して、使える」日本初のAPIの総合メディアであり、APIマーケットプレイスです。
API関連ニュースやノウハウ記事だけでなく、開発者がAPIを利用しやすくなるなるよう様々な機能を揃えています。


目次

  1. APIを利用する
    1. APIを探す
    2. APIを試す
      1. 会員登録をする
      2. 会員登録の流れ
      3. 会員MY PAGE画面
      4. 会員ができること
  2. APIを登録する
    1. 登録から公開までの流れ
  3. 会員を脱退する

APIを利用する

APIbankに登録されているAPIを探すのは簡単です。
検索窓から入力したり、ディレクトリから簡単に探すことができます。

〉API一覧から探す

希望のAPIが見つからない場合

こちらのAPIリサーチサービスからご依頼頂くと、編集部が世界中のAPIからご希望にあうAPIを代わりに探し、もし見つかった場合はご連絡いたします。

必ず見つかることやご連絡できることをお約束するものではありませんが、ぜひご活用ください。

APIを試す

APIbankに登録されているいくつかのAPIは、テストをすることができます。
テストが可能なAPIについては APIから探すで表示されるAPI一覧の「API TEST」の項目に緑のマークでテスト可能なことが表示されます。

APIを試す

該当のAPIの詳細ページにて「APIテスト」ボタンがあるので、そちらを押すことでテスト画面に遷移することができます。(下のボタンは画像です。この画面では押すことができません。)

APIテスト

テストをするには、下記の会員登録が必要になります。

会員登録をする

会員登録は右上の会員登録ボタン から可能です。
もしくはログインからSNSアカウントでログインをすることもできます。その場合は個人アカウントになります。

会員登録

会員登録の流れ

  1. 規約に同意します。
  2. 個人会員か法人会員かを選びます。法人登録をするとAPI提供者として法人でサービスを提供できます(※法人番号が必要です)。
  3. ユーザー名(メールアドレス)とパスワードを入力します。個人の場合はニックネームを。企業の場合は担当者情報をいれて登録に進みます(重複登録はできません)
  4. 登録申し込みをするとメールが届きます。届いたメールに承認をすると無事に会員登録が完了します。

会員MY PAGE画面

会員でログインすると、右上に「MY PAGE」メニューが表示されます。

アクセスすると、会員専用メニューが表示されます。

会員専用メニュー

会員ができること

  • 1つのAPIKEYで様々なAPIをテスト・使用することができます。
  • 上記API KEYの再発行ができます。
  • APIbankで使用申請したAPIを一覧で管理できます。
  • APIプロバイダ(提供者)への切替。自作APIを登録、公開することができます。
  • 会員情報の変更ができます。


APIを登録する

APIbankの会員からAPIプロバイダーに切替えると、自作APIを登録、公開することができます。
※現在のところ無料のREST APIにのみ対応しています。

登録から公開までの流れ

以下の流れで登録できます。

  1. 会員登録をする
  2. MY PAGEよりAPIプロバイダーの申請をする(申請はAPI登録メニューから可能)
  3. MY PAGEの左メニューAPI登録を押すと「API新規登録」ボタンが表示されるので押下する
  4. APIの基本情報を入力する

API新規登録

APIのEnd Pointの情報を入力する
  1. End Pointボタンを押す

End Pointボタンを押す

  1. APIの情報が表示され、その下の「Registering」ボタンを押します。

Registeringボタンを押す

  1. EndPointの情報を入力します。

隠しパラメーター

特に注意すべき記入ポイントを記載します。

End Point Default Info
End Point Group
自分で作成した任意の名前のグループを選びます。グループ名は、API管理画面で自作できます。初期で用意されているのはBaseグループです。
Path
?まで入れて記入ください。例)/video/search?
TEST available
Yにすると、ユーザーがAPIのTESTができるようになります。
Header setting
Add+ボタン
headerで送付するパラメータが決まっている場合は活用してください。必要なければこの作業は省略できます。
Parameter setting
Add+ボタン
パラメーターを追加する時に使います。
Name
パラメーターの名前です。
Type Example
型とユーザーに表示する初期値(Default値)を入力します。型はString,Number,Booleanなどです。
Option Hidden
上部がOptionで、必須パラメーターの場合はNにします。Hiddenは、ユーザーにパラメーターを表示するか否かを選べます。Yにするとユーザーに表示されないので、APIKeyなどを入れるのに活用できます。
Usage range
現在は「両方のサーバー」を選んでください。
Description
パラメーターの説明文を入れます。
Error message setting
Add+ボタン
レスポンスのhttpステータスごとのエラーメッセージをユーザーに表示する場合に使用します。必要なければこの作業は省略できます。
公開申請を出す

申請が受理されると、APIbankに登録され、ユーザーに公開されます。



会員を脱退する

MY PAGEの「基本会員情報」メニューから脱会申請ができます。


loading