Mosaqo API

QR オートメーション用のパブリック API と Webhook

Mosaqo パブリック API はワークスペーススコープのキーを使用します。最小スコープから開始し、書き込みには冪等性キーを使用し、レートが制限されている場合は Retry-After を尊重します。

概要

実務で何が変わるか

シークレットは一度公開されますので、大切に保管してください。

QR レコード、パブリッシング、分析、バルクおよび Webhook。

すべての本番リクエストは HTTPS を使用します。

X-Mosaqo-API-Key でシークレットを送信します。使用可能なスコープには、qr:read、qr:write、exports:read、analytics:read が含まれます。キーは期限切れになったり、取り消されたり、IP 許可リストを使用したりすることができます。

リクエストの作成および公開には、1 ～ 128 文字の冪等性キーが必要です。キーを再使用するのは、24 時間以内に同一のペイロードを再試行する場合のみです。

HTTP 429 で、Retry-After を読み取り、バックオフで再試行します。 401 は通常、キーが欠落している、取り消されている、有効期限が切れている、制限されている、またはスコープが不十分であることを示します。

必要なイベントのみをサブスクライブし、HTTPS で受け入れて迅速に応答します。 Mosaqo は配信ステータスを記録し、ワークスペースからの再生をサポートします。

FAQ

完全な API コントラクトはどこにありますか?

OpenAPI 3.1 コントラクトは、Mosaqo API でバージョン管理されています。 Web ワークスペースでキーを作成し、公開されたコントラクトをエンドポイントの詳細に使用します。

次のステップ