コンテンツへスキップ

ecentic API エラー。

ecentic APIのすべての失敗レスポンスは、HTMLページではなく、型が定義されたエラードキュメントです。コードが契約そのものです。コードは安定しており、機械で読み取れ、安全に条件分岐に使えます。

RFC 9457 · 安定したコード · 解決ヒント

01

problemドキュメントの形式

APIが返すすべての4xxおよび5xxで、単一のメディアタイプと単一のスキーマを使用します。

application/problem+json

レスポンスにはContent-Type: application/problem+jsonが設定されます。これは意図的にapplication/jsonではありません。このメディアタイプによって、汎用クライアントはレスポンス本文が要求したリソースではなく失敗内容を示していると判断できます。

レスポンス例

レスポンスを確認

type
このリファレンス内で問題を識別するURIです。
code
クライアント側で分岐処理に利用できる安定した識別子です。
title
人が読める短い概要です。
status
HTTPステータスを本文内でも繰り返し示します。
detail
このリクエストで発生した具体的な問題です。
resolution
障害を解決するための次の手順です。
documentation
このレスポンスに対応するリファレンスページです。
instance
判明している場合、この結果を生成したリクエストパスです。
02

エラーカタログ

コードは公開後に固定されます。タイトルやヒントの表現は変更される場合がありますが、コードは変更されません。

12公開済み問題コード

解決方法を確認するにはコードを開いてください。各コードには固定リンクがあります。

固定リンク: not-found

解決方法

Check the path against the OpenAPI document at /openapi.json or the API catalog at /.well-known/api-catalog.

固定リンク: method-not-allowed

固定リンク: unauthenticated

固定リンク: unauthorized

固定リンク: payment-required

固定リンク: subscription-required

固定リンク: invalid-request

固定リンク: validation-failed

固定リンク: conflict

固定リンク: rate-limited

固定リンク: upstream-timeout

固定リンク: internal-error