ゲートウェイは次のURL形式でアクセスできます。

https://metergate.dev/v1/<slug>/<path>

<slug>は呼び出すAPIの短縮名です。次の例では、架空のエンドポイントdemoをパス/getで呼び出します。

curl -H "Authorization: Bearer YOUR_API_KEY" https://metergate.dev/v1/demo/get

AuthorizationヘッダーにAPIキーをBearerトークンとして指定します。提供事業者が応答したAPI呼び出しは、4xxのエラーであってもすべて計測されます。計測されたかどうかは、各レスポンスのX-Meteredヘッダーで分かります。精算は暦月の終了後にまとめて行われます。

課金開始までは、応答に X-Billing-Starts: unannounced が付きます。それまでは、呼び出しに費用は発生しません。開始がまだ告知されていない間は unannounced、告知後(少なくとも14日前にメールで)はその時点が入ります。このヘッダーは課金開始までのみ付与されます。付与されていない場合は精算が有効であり、登録されている呼び出し1回あたりの価格が適用されます。

クイックスタート

  1. 新規登録を行い、メールアドレスを確認してください。メールアドレスが未確認の場合、継続利用契約は申し込めません。
  2. アカウント →「お支払いと利用状況」でカードを登録してください。
  3. 付加価値税識別番号(USt-IdNr.)は自動で確認されます。有効と確認されて初めて、継続利用契約を申し込めます。確認の状況はアカウント →「会社情報」で確認できます。
  4. カタログで必要なAPIの継続利用契約を申し込んでください。
  5. APIキーでキーを作成し、ゲートウェイを呼び出します。/v1/<slug>/<path>のとおり、slugに続くパスもURLの一部です。

応答とエラー

ステータス意味
200成功です。提供事業者のAPIの応答をそのまま転送します。
400invalid_request—パラメータがAPIの入力スキーマに一致していません。この確認は、提供事業者が確認を有効にしている場合にのみ行われます。
401APIキーが無効、または指定されていません。
402カードが登録されていない、継続利用契約の与信限度額に達している、またはAPIキーの支出上限額に達しています。後の2つの場合、応答のretry_atにいつから再度利用できるかが示されます。
402subscription_suspended—カードの決済に失敗したため、継続利用契約が一時停止されています。/balanceで支払いを完了してください。完了後、利用は自動的に再開されます。
403subscription_required—このAPIについて有効な継続利用契約がありません。カタログで申し込んでください。
404APIが見つかりません。
405method_not_allowed—このAPIでは、そのメソッドは許可されていません。許可されているメソッドはAllowヘッダーに示されます。
425objection_window_pending—自動で成立した継続利用契約が、まだ撤回可能期間中です。期間の終了を待つか、/keysで承諾してください。
429rate_limit_exceeded—短時間に呼び出しが集中しています。間隔を広げながら再試行してください。
502提供事業者のAPIでエラーが発生しました。この呼び出しは計測されません。
503platform_frozen—運用を一時的に停止しています。計測も請求も行われません。時間をおいて再試行してください。

提供事業者の応答のうちステータスが500未満のもの(4xxを含む)は、そのまま転送され、計測されます。計測されたかどうかは、各レスポンスのX-Meteredヘッダーで分かります。すべてのエラーコードとその意味は/api/v1/errorsに掲載しています。