API

API 개요

SEW는 플랫폼의 모든 부분을 통합하고 자동화하며 확장할 수 있도록 완전히 접근 가능한 최신 API 계층을 제공합니다. 디바이스 관리, 프로젝트 운영, 파이프라인 실행, ID 관리, 원격 엔지니어링을 포함한 거의 모든 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는 사용자, 역할 및 권한 정보에 대한 접근을 제공합니다. 외부 ID 시스템과의 통합, 사용자 지정 프로비저닝 워크플로, 권한 부여 및 RBAC 기반 운영에 관한 고급 자동화를 지원합니다.

IDEaaS API

IDEaaS API는 브라우저 기반 엔지니어링 기능을 제공하여 외부 도구나 오케스트레이터가 엔지니어링 세션을 생성하고, PLC 프로젝트를 열고, 벤더별 IDE와 원격으로 상호 작용할 수 있게 합니다. 이를 통해 자동화된 엔지니어링 파이프라인, 원격 워크스페이스, 기존 DevOps 또는 IT/OT 플랫폼과의 긴밀한 통합이 가능합니다.

---

코드 예제

SEW API를 사용자 환경에 빠르게 통합할 수 있도록, 이 섹션에는 실용적인 엔드투엔드 예제가 포함되어 있습니다. 이러한 예제는 인증 방법, 데이터 조회, 파이프라인 작업 트리거, 외부 애플리케이션과의 통합 방법을 보여줍니다.

각 예제는 토큰 관리, 오류 처리, 페이지네이션, 권장 보안 구성 등의 모범 사례를 강조합니다.