SDK と API クライアント
HTTP クライアントから Oblic API を呼び出します。API は HTTPS と JSON を使用しており、各バージョンの OpenAPI ドキュメントから、ジェネレーターで使用言語の型付きクライアントを生成できます。
OpenAPI ドキュメント
| バージョン | ドキュメント | 認可方法 |
|---|---|---|
| v1 | external-v1.json | API キー(認証) |
| v2 | external-v2.json | OAuth アクセストークン(API v2) |
- 各操作には名前があります(
operationId)。sendEmailやlistMessagesなどの名前を、ジェネレーターがメソッドに変換します。 - v1 ドキュメントにはキーの要件が記載されています。 各操作の
x-oblic-scopesは、キーが少なくとも一つ保持する必要があるスコープを列挙し、x-oblic-key-rolesはその操作を呼び出せるキーのロールを列挙します。 - v1 ドキュメントでは各拒否を一度だけ定義しています。 各操作の
defaultレスポンスは、statusがerrorに設定されたエンベロープとエラーを表します。
クライアントの生成
多くのジェネレーターは OpenAPI 3.1 ドキュメントを読み込めます。Java が必要な OpenAPI Generator を使用する例です。
v1 用 TypeScript クライアント
npx @openapitools/openapi-generator-cli generate \
-i https://docs.oblic.app/openapi/external-v1.json \
-g typescript-fetch \
-o ./oblic-client
-g python、-g go、-g java、-g php を指定すると、それぞれの言語のクライアントを生成できます。生成されたクライアントの送信処理を確認してください。ジェネレーターは Idempotency-Key を自動で追加しないため、再試行する可能性がある送信には必ず指定します。