API で外部からデータを操作する
外部のシステムから Synqlet の REST API を使って、組織のデータを操作する流れです。
-
APIキーを発行する
「設定 > APIキー」からAPIキーを発行します。キーは作成直後に1度だけ表示されるので、安全に保管してください。→ APIキーの発行
-
エンドポイントを確認する
APIリファレンス(Redoc)で、利用したいエンドポイントのパス・パラメータ・レスポンスを確認します。→ APIリファレンス
-
リクエストを送る
X-API-KeyヘッダーにAPIキーを指定して、https://api.synqlet.com/api/...にリクエストします。→ API の概要Terminal window curl https://api.synqlet.com/api/flows \-H "X-API-Key: sk_synqlet_xxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"