APIs
Visão geral das APIs
O SDA fornece uma camada de API moderna e totalmente acessível que permite integrar, automatizar e estender todas as partes da plataforma. Praticamente todos os recursos da plataforma SDA — incluindo gestão de dispositivos, operações de projeto, execução de pipelines, gestão de identidades e engenharia remota — são expostos por meio de APIs seguras e versionadas. Isso permite que os clientes criem fluxos de trabalho personalizados, automatizem processos de engenharia e integrem o SDA a sistemas corporativos e cadeias de ferramentas já existentes.
Esta seção documenta as principais APIs disponíveis no SDA e apresenta exemplos práticos para ajudá-lo a começar rapidamente. Os exemplos de código são fornecidos em linguagens comuns, como Python, com padrões que podem ser adaptados a JavaScript, C# e outros ambientes, conforme necessário.
Principais categorias de API
Asset API
A Asset API fornece acesso programático a dispositivos, projetos, grupos de recursos e metadados relacionados. Ela permite que sistemas externos listem, consultem, atualizem e orquestrem ativos dentro do SDA, sendo ideal para sincronização com CMDB, integração automatizada de ativos e gestão do ciclo de vida de ativos orientada a dados.
Job API
A Job API permite acionar, monitorar e gerenciar tarefas operacionais, como backups, implantações, snapshots, rotações de senha e outras ações de pipeline. É comumente utilizada para automação no estilo CI/CD, backups noturnos e integração com sistemas de tickets ou de fluxo de trabalho.
Identity API
A Identity API fornece acesso a informações de usuários, funções e permissões. Ela oferece suporte à integração com sistemas de identidade externos, fluxos de provisionamento personalizados e automação avançada relacionada a direitos de acesso e operações baseadas em RBAC.
IDEaaS API
A IDEaaS API expõe recursos de engenharia baseados em navegador, permitindo que ferramentas externas ou orquestradores criem sessões de engenharia, abram projetos de automação e interajam remotamente com IDEs específicas de cada fabricante. Isso viabiliza pipelines de engenharia automatizados, espaços de trabalho remotos e integração profunda com plataformas de DevOps ou de TI/OT existentes.
Exemplos de código
Para ajudá-lo a integrar rapidamente as APIs do SDA ao seu ambiente, esta seção inclui exemplos práticos e completos. Esses exemplos demonstram como autenticar, recuperar dados, acionar ações de pipeline e realizar integrações com aplicações externas.
Cada exemplo destaca boas práticas, como gestão de tokens, tratamento de erros, paginação e configurações de segurança recomendadas.