Visão Geral da API
Introdução à API Pública da Imara — o que é, para quem é e como funciona.
O que é a API da Imara?
A API Pública da Imara permite que você interaja com seus dados de conformidade de forma programática. É possível automatizar o upload de evidências, consultar o status de controles, disparar avaliações e integrar a Imara às suas ferramentas internas ou pipelines de CI/CD — tudo sem precisar abrir o painel.
Para quem é a API?
A API foi desenvolvida para equipes que querem ir além do painel:
- Desenvolvedores que automatizam a coleta de evidências a partir de ferramentas internas
- Engenheiros de DevOps e Segurança que incorporam verificações de conformidade em pipelines de deploy
- Times de TI que sincronizam dados da Imara com sistemas SIEM, ticketing ou ITSM
- Analistas que constroem relatórios personalizados consumindo dados sob demanda
Como funciona
A API da Imara utiliza o fluxo OAuth 2.0 Client Credentials — também chamado de autenticação Machine-to-Machine (M2M). Em vez de fazer login com usuário e senha, sua aplicação se autentica com um Client ID e um Client Secret, fornecidos ao criar uma chave de API na plataforma.
O fluxo é:
- Crie uma chave de API em Configurações → Chaves de API
- Use o Client ID e o Secret para solicitar um token de acesso
- Inclua o token no cabeçalho Authorization: Bearer de cada requisição
- Os tokens expiram após uma hora — basta solicitar um novo com as mesmas credenciais
Disponibilidade por plano
O acesso à API está disponível no plano Starter e acima. O plano Free não inclui acesso à API. O número de chaves de API que você pode manter ao mesmo tempo depende do seu plano — Professional permite até 5 chaves e Enterprise até 20. Veja o artigo Chaves de API para mais detalhes.
Próximos passos
- Crie sua primeira chave de API → veja Chaves de API
- Aprenda a se autenticar → veja Autenticação da API
- Explore o que é possível fazer → veja Recursos Disponíveis na API