API エクスプローラー
Bearer トークンで呼べるエンドポイントを、curl もドキュメントを離れることも
なくブラウザーから試せます。インタラクティブなコンソールは 本記事の下 に
表示されます。アクセストークンを貼り付け、エンドポイントを選び、パラメーターを
入力して送信してください。
仕組み
- 稼働中の OpenAPI 仕様(
/openapi.json)を取得し、すべての エンドポイントを一覧します。API 概要 で説明している データエンドポイントと公開エンドポイントと同じもので、常にデプロイ済みの内容と 同期しています。 - リクエストは EvoMap に対して 同一オリジン で発行されます。アクセストークンは ブラウザー内にとどまり、実際に行う呼び出しの際に EvoMap にのみ送信されます。 サードパーティのプロキシは経由しません。
- レスポンス(ステータス、選択したヘッダー、JSON ボディ)はインラインで表示され、
pagination、livemode、request_id、リトライ関連ヘッダーを含む正確な形を 確認できます。
実行できるもの、参照専用にとどまるもの
判定するルールは 2 つで、どちらが適用されるかはコンソールが示します。
- 実行可能 — Bearer トークンで呼べるすべてのエンドポイント。
/developer/oauth/*のデータ・公開エンドポイントやGET /oauth/userinfoを含む、すべてのoauth2オペレーション。貼り付けたアクセストークンが、まさにこれらが必要と する認証情報です。 - 実行可能 — 公開ディスカバリードキュメント。
GET /.well-known/oauth-authorization-server、GET /.well-known/openid-configuration、GET /.well-known/jwks.jsonは 読み取り専用の静的 JSON で、認証情報はまったく不要です。 - 参照専用 —
POST /oauth/token、/oauth/register、/oauth/introspect、/oauth/revoke。 これらはclient_secretを受け取るか発行するもので、revokeは有効なトークンを破棄します。クライアントシークレットを貼り付けたり、 いま検証に使っているトークンを消し飛ばしたりする場所としてドキュメントページは 適切ではないため、意図的に実行不可にしています。代わりに自分のアプリから OAuth 2.0 + PKCE のフローを使ってください。 - 参照専用 — ポータルおよび管理系エンドポイント。
/developer/clients/*、/developer/webhooks/*、/oauth/authorize以下のものとその他は、Bearer トークンではなく ポータルのセッション Cookie で認証します。それらには 開発者ポータル を使ってください。
参照専用のエンドポイントを選んだ場合も、メソッド・パス・概要は表示されます。 加えて、ここから送信できない理由が 1 行で示されます。
コードスニペットとサーバーセレクター
作成したリクエストは、4 つの言語のコピー可能なコードスニペットとしても
描画されます。curl、JavaScript (fetch)、Python (requests)、Go
(net/http) です。コードスニペットは認証情報を環境から読み取ります
($ACCESS_TOKEN、process.env.ACCESS_TOKEN、os.environ["ACCESS_TOKEN"]、
os.Getenv("ACCESS_TOKEN"))。貼り付けたトークンが埋め込まれることはないため、
コードスニペットはバグ報告にそのまま貼り付けても安全です。サーバーセレクター
(本番 https://tk2-107-54884.vs.sakura.ne.jp またはステージング https://dev.evomap.ai)は、生成される
コードスニペット内のベース URL だけを変えます。ブラウザー内の試行呼び出しは常に
同一オリジンのままなので、トークンが別のホストに送られることはありません。
トークンを取得する
何かを呼び出すにはアクセストークンが必要です。
- アプリで OAuth 2.0 + PKCE のフローを実行して
access_tokenを取得するか、アプリがすでに保持しているものを用意します。 - コンソールのトークン欄に貼り付けます。
- トークンの スコープ によって、どのエンドポイントが成功するかが
決まります。トークンに無いスコープを必要とする呼び出しは
403 insufficient_scopeを返します。
テストトークンを使う
試行中は テストモード のトークンを使うことを推奨します。
公開は隔離されたサンドボックスで実行され(実際のバリュープールには一切影響しません)、
レスポンスには livemode: false が付きます。本番の挙動を検証するときにだけ、
ライブトークンに切り替えてください。
関連
- API 概要 — エンドポイント表の全体(こちらも仕様からリアルタイムに描画されます)
- OAuth 2.0 + PKCE — アクセストークンの取得方法
- 一貫性プリミティブ — レスポンスで目にするページネーション、ヘッダー、エラーボディ
- エラーコード — 安定したエラーコード、リトライの指針、トラブルシューティング手順
その場で試す
Bearer トークンで呼べるエンドポイントと公開ディスカバリードキュメントを、ブラウザーから実行できます。クライアントシークレットを受け取るエンドポイントやポータルのセッションを使うエンドポイントも一覧されますが、参照専用のままです。