コンテンツへスキップ
Peak Atlas

開発者と API

まずデータの流れを明確にする。 それから連携を構築する。

どのシステムが、どのデータを読み取り、または変更すべきか?まず既存の接続を確認しましょう。独自の連携を作る場合は、このブリーフィングが必要な範囲と未解決の技術的課題の整理に役立ちます。

アクセスとドキュメント

導入前に知っておくべきこと。

このページは技術的な概要を提供するものです。公開済みのエンドポイント、認証、制限を記載した公開APIリファレンスは、まだここでは公開していません。開発工数を計画する前に、ご自身のユースケースについてこれらの情報をチームとご確認ください。

既存の連携
連携カタログでツールを探しましょう。掲載されているだけでは、ワークフローにどのデータの方向やアクションが使えるかは確定しません。
独自の連携
必要なオブジェクトとアクションを記述します。承認済みのアクセス、文書化されたエンドポイント、適切なテスト環境について確認してください。
運用
上限、エラー処理、リクエストの再試行、インターフェースの変更、障害時の連絡先を明確にしましょう。

記入用 · 登録不要

最初は具体的な流れが1つあれば十分です。

  1. 結果:連携後、どのタスクが確実に完了しているべきか?
  2. データ:どのオブジェクトと項目を、どの方向に転送するか?
  3. トリガー:ワークフローはいつ、どのくらいの頻度と量で始まるか?
  4. 権限:誰が閲覧、変更し、連携を承認できるか?
  5. エラー時:データの欠落、重複、障害が起きたらどうなるか?
  6. 検収:どのテストケースで接続が機能していると判断しますか?
ブリーフを Markdown でダウンロード

ユースケースを説明してください。

関係するシステムと、希望するデータの流れをお知らせください。それをもとに、どのアクセスと次の技術的なステップが適しているかを確認できます。

チームと連携について確認する