API
API の概要
SDA は、プラットフォームのあらゆる部分を統合、自動化、拡張できる、完全にアクセス可能な最新の API レイヤーを提供します。デバイス管理、プロジェクト操作、パイプライン実行、アイデンティティ管理、リモートエンジニアリングなど、SDA プラットフォームのほぼすべての機能が、セキュアでバージョン管理された API を通じて公開されています。これにより、お客様はカスタムワークフローの構築、エンジニアリングプロセスの自動化、既存のエンタープライズシステムやツールチェーンへの SDA の統合を実現できます。
このセクションでは、SDA 内で利用可能な主要な API を説明し、すぐに使い始められるよう実践的な例を提供します。コードサンプルは Python などの一般的な言語で提供されており、必要に応じて JavaScript、C#、その他の環境にも応用できるパターンとなっています。
主な API カテゴリ
Asset API
Asset API は、デバイス、プロジェクト、リソースグループおよび関連メタデータへのプログラムによるアクセスを提供します。外部システムから SDA 内のアセットを一覧表示、クエリ、更新、オーケストレーションできるため、CMDB の同期、アセットオンボーディングの自動化、データ駆動型のアセットライフサイクル管理に最適です。
Job API
Job API を使用すると、バックアップ、デプロイメント、スナップショット、パスワードローテーションなどのパイプラインアクションといった運用タスクをトリガー、監視、管理できます。CI/CD スタイルの自動化、夜間バックアップ、チケッティングシステムやワークフローシステムとの統合によく利用されます。
Identity API
Identity API は、ユーザー、ロール、権限情報へのアクセスを提供します。外部アイデンティティシステムとの統合、カスタムプロビジョニングワークフロー、権限付与や RBAC ベースの操作に関する高度な自動化をサポートします。
IDEaaS API
IDEaaS API は、ブラウザベースのエンジニアリング機能を公開し、外部ツールやオーケストレーターがエンジニアリングセッションを作成し、オートメーションプロジェクトを開き、ベンダー固有の IDE をリモートで操作できるようにします。これにより、エンジニアリングパイプラインの自動化、リモートワークスペース、既存の DevOps または IT/OT プラットフォームとの深い統合が可能になります。
コード例
SDA の API をお客様の環境へ迅速に統合できるよう、このセクションでは実践的なエンドツーエンドの例を紹介します。これらの例では、認証方法、データの取得、パイプラインアクションのトリガー、外部アプリケーションとの統合方法を示します。
各例では、トークン管理、エラー処理、ページネーション、推奨されるセキュリティ構成などのベストプラクティスを取り上げています。