APIキーとAPI

APIキーはプログラムに属するパスワードです。人に属するパスワードと同様に扱ってください：システムごとに一つ発行し、そのシステムが変更されたときに置き換えてください。

キーを作成する

1. 開く API → API管理 そして押します 新しいキー.
2. どのシステムが使用するかを示す名前を付けましょう。
3. その 権限: フルアクセス、またはシステムが必要とする領域のみ。ほとんどの領域は、読み取り、作成、変更を区別します。
4. 有効期限を選択するか、なしを選択してください。
5. 使用 表示 および コピー キーカードでクリックして、キーを呼び出しシステムに渡します。システムはそれを authtoken ヘッダー。

各キー・カードには、権限、作成日が表示されます。 最終使用 および「アクティブ」や「5日後に期限切れ」のようなバッジ。

期限切れ前にキーを更新

キーの有効期限の14日前に、ベルに1つの通知が表示されます。押す 更新 キーカードでクリックし、新しい有効期限を選択します。IDupは同じ権限を持つ新しいキーを作成します。表示は一度だけなので、すぐにコピーしてください。古いキーは自分の有効期限まで有効なので、システムをギャップなく切り替えることができます。

到達可能なエリア

APIは顧客データをカバーし、プランに応じて、物件と賃貸、検索プロファイル、税ファイル、信託ファイル、会計、給与計算、領収書スキャンを含みます。AI Studioと受信トレイには独自のエリアがあります。APIガイドにはプランに含まれるエリアのみが記載されています。

APIガイド

開く ドキュメンテーション API管理ページのタブ、または API → APIガイド。各エリアには、そのフィールド、コピー可能なリクエスト例、例の回答、エラーコードが表示されます。

Webhookと他のインターフェース

• その Webhook タブはイベントが発生したときにシステムに送信します — 詳細は ウェブフックを使用して自分のシステムにイベントを送信.
• Customer APIがオンになっている場合、a 顧客 API 設定 タブを開くと、たとえば顧客がAPIを通じて登録できるかどうかの設定が表示されます。
• 自動化 / ワークフロー → 技術インターフェース GraphQLインターフェースのためのトークンを発行します。
• AI Studio → 個人用APIキー は別のキーセットです。

安全に保つ

1. システムごとに一つのキー、共有キーはありません。
2. システムが必要とする権限のみをキーに与える。
3. 有効期限を設定し、スケジュールに従って更新します。
4. キーを知っている人が退職するか、システムがオフになるとすぐにキーを削除します。