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