APIを探して、試して、使える

利用ガイド

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

APIを利用する

APIを探す

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

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

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

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

APIを試す

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

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

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

会員登録をする

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

会員登録の流れ

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

会員MY PAGE画面

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

会員ができること

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

APIを登録する

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

登録から公開までの流れ

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

会員登録をする
MY PAGEよりAPI提供者の申請をする（申請はAPI登録メニューから可能）
MY PAGEの左メニューAPI登録を押すと「API新規登録」ボタンが表示されるので押下する
APIの基本情報を入力する

APIのエンドポイントの情報を入力する

管理ボタンを押すと
APIの情報が表示され、「機能」タップの下の「エンドポイント登録」ボタンを押します。
エンドポイントの情報を入力します。

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

エンドポイント基本情報

エンドポイントグループ: 自分で作成した任意の名前のグループを選びます。グループ名は、API管理画面で自作できます。初期で用意されているのはBaseグループです。
経路: ?まで入れて記入してください。例）/video/search?
TEST可否: Yにすると、ユーザーがAPIのTESTができるようになります。

ヘッダー設定

追加+ボタン: ヘッダーで送付するパラメータが決まっている場合は活用してください。必要なければこの作業は省略できます。

パラメータ設定

追加+ボタン: パラメーターを追加する時に使います。
パラメータ名: パラメーターの名前です。
パラメータタイプ Example: 型とユーザーに表示する初期値(Default値）を入力します。型はString,Number,Booleanなどです。
オプション Hidden: 上部がオプションで、必須パラメーターの場合はNにします。Hiddenは、ユーザーにパラメーターを表示するか否かを選べます。Yにするとユーザーに表示されないので、APIKeyなどを入れるのに活用できます。
使用範囲: 現在は「両方のサーバー」を選んでください。
説明: パラメーターの説明文を入れます。

エラーメッセージ設定

追加+ボタン: レスポンスのhttpステータスごとのエラーメッセージをユーザーに表示する場合に使用します。必要なければこの作業は省略できます。

公開申請を出す

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

会員を退会する

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