リセラー/導入チェックリスト

リセラー向けチェックリスト

Wokey API を自社の下流ユーザーに再販する場合は、以下のリストを順に確認してください。各項目から詳しい説明にリンクしています。

チェックリストlink

  1. 1

    すべてのリクエストで X-End-User-Id を送信する

    1 つのキーで多数のエンドユーザーにサービスを提供する場合、このヘッダーでリクエストがどのエンドユーザーのものかを示します。あるエンドユーザーが違反を繰り返した場合、Wokey はそのユーザーだけを制限し、ほかのユーザーはそのまま利用を続けられます。エンタープライズアカウントとリセラーアカウントは、コンソールで制限中のユーザーを確認し、制限を解除することもできます。

    エンドユーザー ID と制限 →

  2. 2

    モデルの拒否を検出する

    拒否された場合も HTTP 200 が返るため、レスポンス内のフィールドから検出してください。拒否を検出したら、同じリクエストを再試行せず、ユーザーに内容の変更を求めてください。

    モデルの拒否 →

  3. 3

    違反ユーザーを早めに止める

    拒否が繰り返されると、レート制限、モデルの停止、違反手数料の対象になります。X-End-User-Id の有無にかかわらず違反はあなたのアカウントに計上されるため、Wokey にリクエストを送る前にコンテンツをフィルタリングしてください。

    違反時の手数料と制限 →

  4. 4

    ステータスコードに応じてエラーを処理する

    残高不足(402)、レート制限(429)、上流エラー(502、504、529)を区別し、それぞれに応じてユーザーへの通知や再試行を行ってください。サポートに問い合わせる際は、レスポンスヘッダー x-wokey-request-id を添えてください。

    エラーコード →

  5. 5

    残高と使用量を監視する

    アカウント残高は /v1/dashboard/balance で、キーごとの使用量と残りの上限は /v1/usage と /v1/key で照会できます。残高がなくなる前にチャージしてください。

    残高と使用量 →

  6. 6

    必要に応じてベンダーを指定する

    1 つのモデルに複数のベンダーがある場合は、リクエストボディの provider でベンダーを必須指定または除外できます。

    ベンダー指定 →