API インテグレーションの作成

概要

このページでは、Datadog API インテグレーションを作成する方法をテクノロジーパートナーに説明します。

API インテグレーション

Datadog API エンドポイントを使用して、バックエンドからデータを送信し、ユーザーの Datadog アカウントからデータを引き出すことで、顧客の体験を豊かにします。テクノロジーパートナーは、自社の環境内でコードを書き、ホスティングします。

API インテグレーションは、SaaS ベースで、ユーザーを認証する既存のプラットフォームを持っているテクノロジーパートナーに最適です。

API インテグレーションは、以下の種類のデータを Datadog に送信できます。

You can include out-of-the-box assets such as monitors, dashboards, and log pipelines with your API integration. When a user clicks Install on your integration tile, they are prompted to follow the setup instructions, and all out-of-the-box dashboards will appear in their account. Other assets, such as log pipelines, will appear for users after proper installation and configuration of the integration.

Integrations または Marketplace ページに製品を表示するには、タイルを作成する必要があります (下の写真)。このタイルには、製品のセットアップ方法に関する説明や、インテグレーションが何をするのか、どのように使用するのかについての一般的な情報が記載されます。

Integrations ページに表示される製品の例を表すタイル

開発プロセス

OAuth

Datadog では、ユーザーから直接 API キーやアプリケーションキーをリクエストする代わりに、OAuth クライアントを使用して API ベースのインテグレーションの認可とアクセスを処理することが求められています。OAuth の実装は、すべての Datadog サイトをサポートする必要があります。

詳しくは、OAuth for Integration、認可エンドポイントをご参照ください。

手始めに、Vantage などの integrations-extras リポジトリで OAuth を使用する例を調べてみるとよいでしょう。

インテグレーションの構築

API ベースのインテグレーションを構築するプロセスは、次のようになります。

  1. Datadog パートナーネットワークに合格すると、Datadog テクノロジーパートナーチームと面談し、提供する製品やユースケースについて話し合います。
  2. 開発用の Datadog サンドボックスアカウントをリクエストします。
  3. インテグレーション開発を開始します。これには、インテグレーションコードの作成とホスティング、OAuth プロトコルの実装が含まれます。
  4. インテグレーションと OAuth クライアントを、Datadog サンドボックスアカウントでテストします。
  5. 開発作業がテストされ完了したら、Integrations または Marketplace ページにインテグレーションを表示するために、タイルの作成のステップに従ってください。
  6. プルリクエストが送信され、承認されると、Datadog テクノロジーパートナーチームは、インテグレーションを最終確認するためのデモをスケジュールします。
  7. Datadog のサンドボックスアカウントでタイルとインテグレーションをテストしてから公開するか、すべての顧客向けにインテグレーションをすぐに公開するかのオプションがあります。

タイルを作成することで、API インテグレーションの構築を開始します。

インテグレーションを更新する

関連するファイルを編集し、integrations-extras リポジトリ内のインテグレーションのディレクトリに新しいプルリクエストを開くことで、いつでもインテグレーションを更新することができます。

API ベースのインテグレーションでは、新しいデータが送信されるなど新しい機能が追加されたときや、大きなバグが修正されたときに、インテグレーションのバージョンをバンプすることをお勧めします。

インテグレーションのバージョンがバンプされた場合は、CHANGELOG.md ファイルに以下の形式でエントリを追加してください。

## バージョン番号 / 日付

***Added***: 

* New feature
* New feature

***Fixed***:

* Bug fix
* Bug fix

新しい README コンテンツ、マニフェスト情報、またはダッシュボードや推奨モニターなどのアセットを編集または追加する場合、バージョンバンプは必要ありません。

ダッシュボードや推奨モニターなどのアセットに対する更新は、対応するプルリクエストがマージされ、アセットが公開された後に顧客が入手できるようになります。README.md、manifest.json などのコード以外のファイルの更新も、公開後すぐに顧客が入手できるようになります。

参考資料

お役に立つドキュメント、リンクや記事:

Datadog API の使用方法DOCUMENTATION more more OAuth を使った API インテグレーションについてDOCUMENTATION more more Datadog プラットフォームで開発する方法についてDOCUMENTATION more more