ドキュメントとアクセス情報をまとめる
- サービスを登録する
外部APIを特定し、ドキュメントへのリンクまたはテキストを提供します。
- アクセス情報を分けて管理する
接続に必要なテスト環境と本番環境の認証情報を提供します。
- 業務の文脈と結び付ける
既存の接続を、それを利用する領域に関連付けます。
連携に必要な情報を提供する
接続は、サービス名とドキュメントから始まります。どの業務操作に必要なのか、システム間でどの情報をやり取りするのかを説明してください。
登録では、テスト用と本番用のアクセス情報を分けて扱えます。環境の文脈を明確にしたまま、接続の詳細ページで内容を確認してください。
支える業務操作を軸に連携を準備する
必要なやり取りを説明する. 外部サービスは、業務タスクで使う情報を提供したり受け取ったりします。サービス名とドキュメントを登録し、プロジェクトの文脈で想定するやり取りを説明してください。これにより、連携はサービスのURLを超えた実用的な目的を持ちます。
テストと本番を区別する. テスト用と本番用の認証情報は、提供元の別々のアカウントに属している場合があります。対応する項目に入力し、用途を確認してください。これらの文脈を分けることで、開発段階と本番稼働の両方に向けて連携を準備できます。
登録済みの接続を再利用する. 同じ外部サービスが複数の業務領域を支えることがあります。既存の接続を必要な場所に関連付け、その後で関連付けを確認してください。領域から解除することと、プロジェクト全体から削除することは別の判断です。
必要な場所で接続を再利用する
登録済みの接続は、複数の業務領域に関連付けることができます。領域に関連付けられた接続を確認し、適切なサービスを追加または解除してください。
サービスを登録することで、連携の要件を伝えられます。本番環境で利用する前に、状態を確認し、業務フロー全体をテストしてください。
アプリケーションに必要なデータのやり取りを説明する
サービス、送信または受信する情報、そしてそれを利用する業務領域を指定してください。最新のドキュメントへのリンクがあれば、実際の外部仕様を説明しやすくなります。
役立つ例と、サービスが利用できないときに期待される動作を説明してください。そうすれば、提供元の名前だけでなく、ユーザーの業務に沿って接続を検討できます。
サービスの登録からテスト済みのフローまで
サービス情報を提供する. ドキュメントへのリンクまたはその内容と、求められたアクセス情報を提供します。接続を必要とする業務操作を特定してください。
適切な領域に関連付ける. 登録済みの接続を、それを利用する領域に関連付けます。追加や削除の前に、既存の関連付けを確認してください。
完成した連携を確認する. 状態を追跡し、該当する環境で想定したやり取りをテストします。登録しただけでは、フローが動作している証明にはなりません。
外部接続に関するご質問
外部サービスの名前と、ドキュメントへのリンクまたは貼り付けた内容を提供してください。テストと本番に必要なアクセス情報も提供します。名前だけでは連携の動作は定まりません。
既存の接続は複数の業務領域に関連付けられます。コネクタの詳細で関連付けられた領域を確認し、適用範囲をわかりやすく保ってください。
外部接続は、アプリケーションが別のサービスをどのように利用するかを表します。オプションのプロジェクトAPIは、アプリケーションの合意済みの操作を外部に公開します。それぞれ異なる連携ニーズに応えるものです。
コネクタの解除は、ひとつの領域との関連付けにのみ関わります。プロジェクトからコネクタを削除するのは、適用範囲の異なる別の操作です。続行する前に確認内容をお読みください。
実装を追跡し、業務上のやり取り全体をテストしてください。登録したサービスとその有効化状態は参考になる情報ですが、結果の確認の代わりにはなりません。