Skip to main content

概要

このセクションでは、カスタム統合とクライアントを構築するための Diversion API の使用方法を説明します。

認証

Diversion Web アプリの Settings > Integrations から API トークンを生成します。トークンは dvk_ で始まり、一度だけ表示され、個別に取り消せます。手順については API トークンの生成 を参照してください。 API アクセスには Pro プラン以上 が必要です。 特に記載のない限り、すべての API エンドポイントは Bearer トークンで認証されます。

ベース URL

すべての API エンドポイントはベース URL https://api.diversion.dev/v0 を基準としています。

最初のリクエストを行う

トークンを取得したら、/auth/test エンドポイントへリクエストを送って動作を確認できます:

実例: 新しいリポジトリを作成する

エンドポイントの完全なドキュメントは こちら を参照してください。

エラー処理

多くの API エンドポイントから返される共通エラーを以下にリストします。特定のエンドポイント固有のエラーは、そのエンドポイントのドキュメントに記載されています。

エラーフォーマット

すべてのエラーは以下のフォーマットで返されます:

共通エラー

400 Bad Request

リクエストが不正な場合に返されます。 レスポンス例:

401 Unauthorized

認証トークンが無効または期限切れの場合に返されます。 レスポンス例:

403 Forbidden

認証トークンは有効だが、ユーザーがそのエンドポイントへのアクセス権を持たない場合に返されます。 レスポンス例:

404 Not Found

要求されたリソースが見つからない場合に返されます。 レスポンス例:

500 Internal Server Error

サーバーがリクエストを処理できない予期しない状態に遭遇した場合に返されます。 レスポンス例: