共通コンセプト

Digi-Key APIは、OAuth 2.0 Authorization Frameworkを実装します。Oauth 2 Frameworkは、サードパーティアプリケーションに保護されたリソースへの安全なアクセスを委任する業界標準の方法です。DK APIに対して行うすべてのリクエストには、アクセストークンが必要です。
必要なスキルは、OAuth 2.0に精通していることと、OAuth 2.0で承認コードの付与フロー、承認エンドポイント、トークンエンドポイント、リダイレクションエンドポイント、ベアラートークン、リフレッシュトークンの利用に精通していることです。承認コードの付与フローは、DK APIにアクセスするために唯一許可されている方法です。

TLS

DK APIのリソースとサードパーティアプリケーションのリソースを保護するために、すべてのHTTPトラフィックはTLSv1.2暗号化プロトコルを使用して保護されます。クライアントアプリケーションは、TLSv1.2を使用するように開発されます。DKのリソースにアクセスする際には、エンドポイントを検証するとともに、エンドポイントがTLSを使用していることを確認してください。
 

アクセス制御

DK APIのリソースとサードパーティアプリケーションのリソースを保護するには、クライアントアプリケーションのクライアントIDとクライアントシークレットをプライベートに保ち、また保護する必要があります。サードパーティアプリケーションには、クライアントIDとクライアントシークレットが割り当てられます。クライアントIDとクライアントシークレットはどちらもサードパーティアプリケーションに一意です。これらは保護する必要があり、決して公開されてはなりません。

レート制限

DK API製品にはレート割り当て制限があります。 レート制限は製品ごとに適用されます。アプリケーションのレート（使用頻度）は、製品ごとにリクエスト回数/分とリクエスト回数/日の両方によって制限されます。

以下のレート制限は標準製品のものです。

*バッチProductDetailsには、1回のリクエストにつき最大50個の部品番号を格納することができます。

すべてのAPIレスポンスには、クライアントアプリケーションの使用状況を識別するために、次の一連のレスポンスヘッダーが付いています。

アプリケーションがレート制限枠に達すると、クライアントアプリケーションは次のステータスコードを受け取ります。

429 Too Many Requests

バースト制限枠を超過すると、レスポンスヘッダーに次のように表示されます。

JSONレスポンスメッセージは次のようになります。

{
    "ErrorResponseVersion": "3.0.0.0",
    "StatusCode": 429,
    "ErrorMessage": "BurstLimit exceeded",
    "ErrorDetails": "Please try again after the number of seconds in the Retry-After header",
    "RequestId": "fa3e4d88-bfc4-4565-c6d5-a567633c091b",
    "ValidationErrors": []
}

1日あたりの制限枠を超過すると、以下のレスポンスヘッダーが表示されます。

JSONレスポンスメッセージは次のようになります。

{
    "ErrorResponseVersion": "3.0.0.0",
    "StatusCode": 429,
    "ErrorMessage": "Daily Ratelimit exceeded",
    "ErrorDetails": "Please try again after the number of seconds in the Retry-After header",
    "RequestId": "f4a0c1ab-8b47-4a72-e010-8ebe5d78f96c",
    "ValidationErrors": []
}

ステータスコード

各APIは、送信するステータスコードを記録します。返されるステータス（レスポンス）コードはRFC 22616仕様に従っています。通常、返されるステータスコードは次のとおりです。

サポート

DK APIへのアクセスまたは使用に関する技術的なヘルプ情報については、サポートページをご覧ください。