カスタムコネクタ

カスタムコネクタは、ご自身で説明するサービスです。キーを受け付けるインターネット上のAPIなら、どれでも使えます。作成すると、アプリはリストにある他のコネクタと同じようにSetherion経由で使い、キーは当社のサーバーに保管されます。

Connectorsページの右上にある「+」を押し、続けてCustom connectorを押して、次の項目を入力します。

• Details。Display name、リストに表示されるShort description、より詳しいDescription、Category、そして任意でドキュメントのアドレス。
• Authentication。キーの渡し方です。Bearer token、API key in a header（ヘッダー名を指定します）、API key in the address（パラメーター名を指定します）、Username and passwordから選びます。ユーザーに求める項目名（「Password」など）も指定できます。What requests to this API will look likeに、選択に応じた形が表示されます。続いて、すべてのリクエストの起点になるAPI base URLと、Test requestを入力します。これは、有効なキーがなければ失敗する簡単な呼び出しで、たとえば現在のアカウントを返すものです。
• Who may use it。Only your app's team（初期設定）、Visitors can read、Anybodyから選び、続いてアプリが送れるリクエストの種類を選びます。GETは読み取り、それ以外は変更を行います。Visitors can readでは、アプリを開いた人は誰でも読み取りができ、変更できるのはチームだけです。Anybodyでは、許可したすべての呼び出しを誰でも実行でき、訪問者ごとの呼び出しはより厳しく制限されます。そのために作られたAPIにだけ選んでください。
• Agent knowledge。任意ですが、書いておく価値があります。パス、それぞれのリクエストと回答の例、間違えやすい点を書きます。Setherionは、アプリを作るときにこれを読みます。ないとSetherionはパスを推測するしかなく、推測は外れることがあります。たとえば、自分のアカウントを返すパスはどれかを書いておきます。ここにキーは絶対に貼り付けないでください。

フォームにキーは入力しません。Createを押すとコネクタのページが開くので、そこでキーを追加し、Test connectionを押して、他のサービスと同じように接続します。EditとDeleteもそのページにあります。削除するとキーも削除され、それを使っているアプリはすぐに接続できなくなります。

頼んでみましょう。接続してアプリにチェックを入れたら、名前を指定して頼みます。「Acmeの進行中のプロジェクトをダッシュボードに表示して」「Acmeにタスクを作成するボタンを追加して」。

• API base URLはhttps://で始まり、公開されたインターネット上にある必要があります。プライベートネットワーク内のアドレス、IPアドレス、443以外のポートが付いたアドレスは、保存するときと、呼び出しのたびに拒否されます。
• カスタムコネクタはあなた専用です。チームのワークスペースのメンバーに貸し出されることはなく、アプリが使えるコネクタを一覧で指定したワークスペースでも、対象から外されます。
• 最大25個まで作れます。
• 1つのアプリが必要とするキーが1つだけなら、キーとシークレットで十分な場合があります。