開発者向けAPIリファレンス

ご自身のアプリをワークスペースにつなぐためのREST API、キーとスコープ、エラー、レート制限、Webhookの説明です。

場所

⚙️ 設定 › APIリファレンス · ホームページ › リソース › APIリファレンス

この画面を開く
サイドメニュー、認証、エンドポイントが並ぶAPIリファレンス

ステップ

  1. サイドバーの「APIリファレンス」、またはホームページの「リソース」メニューの「APIリファレンス」を開きます。
  2. まず「はじめに」の「ベースURLと共通仕様」、「認証」、「スコープ」を読みます。
  3. 「エンドポイント」をグループごとに確認します。各エンドポイントに、パラメーター、リクエスト本文、レスポンス、エラーが例とともに載っています。
  4. 本番で使う前に、「エラーとステータスコード」、「レート制限」、「Webhook(送信)」を読みます。「OpenAPI JSON」で仕様全体をダウンロードできます。

トラブルシューティング

APIキーはどう入手しますか?

キーはご依頼に応じてワークスペースごとに発行します。アプリ内ではまだ作成できません。ワークスペースのキーはAI分野の開発者向けページに一覧され、ワークスペースの管理者はそこでWebhookの送信先の追加とテストもできます。

ヒント

  • APIはサーバーからだけ呼び出してください。キーをWebページやモバイルアプリに入れないでください。

知っておきたいこと

  • APIリファレンスはサインインしなくても読めます。

関連するハウツー

無料で始める ホーム