APIリファレンス

Synqlet API の全エンドポイントの詳細仕様は、自動生成された APIリファレンス（Redoc） で確認できます。リクエスト・レスポンスのスキーマや、各エンドポイントのパラメータを参照できます。

APIリファレンスを開く

APIリファレンスを開く https://api.synqlet.com/docs

APIリファレンスでは、リソースごとにエンドポイントが一覧表示され、各エンドポイントのクエリパラメータ・ヘッダー（X-API-Key）・レスポンスのスキーマを確認できます。OpenAPI 仕様（スキーマ定義）のダウンロードも可能です。

使い方

1. APIキーの発行 でAPIキーを作成します。
2. APIリファレンスで利用したいエンドポイントを確認します。
3. リクエストの X-API-Key ヘッダーにAPIキーを指定して呼び出します（API の概要 を参照）。