APIリファレンス

以下のすべてのエンドポイント、スキーマ、エラー形式はDUST API自体によって生成され、 ライブで提供されるため、デプロイ済みのAPIと常に一致します。

埋め込みリファレンス

APIリファレンスを読み込み中…リファレンスの読み込みに通常より時間がかかっています。読み込みが終わるまで、新しいタブで開くこともできます。

完全なリファレンスを新しいタブで開く

はじめに

• クイックスタート — 認証済みの最初のリクエストを、最初から最後まで説明します。
• 認証 — APIキー、トークン交換、コンテキストヘッダーについて説明します。
• 規約 — ページネーションと、すべてのエンドポイントで共有されるリクエストコンテキストについて説明します。
• エラー — エラーエンベロープ、実際に発生するエラーコード、復旧方法について説明します。
• DICEガイド — 同じ記録がWebアプリでどのように表示され、動作するかを説明します。

ヒント

TypeScriptクライアントはこの同じ仕様から生成されるため、その型はリファレンスに記載されている内容と常に一致します。

仕様のコピー

仕様は2か所で提供されています。

ソース	URL	最新性
DUST API（ライブ）	https://apid.dustid.io/api/openapi.json	デプロイ済みのAPIと常に一致します。
このドキュメントサイト	/openapi.json	このサイトのビルド時に、APIと同じソースから生成されます。

クライアントを生成する場合やリクエストを検証する場合は、デプロイ済みのAPIと常に一致するライブ版を使用することを推奨します。サイト版はドキュメントのリリースごとに再生成され、このサイトを閲覧中に手軽に利用できます。