Recursos Disponíveis na API

Visão geral

Após autenticada, sua aplicação pode ler e escrever dados de conformidade pela API da Imara. Os recursos são organizados por domínio e seguem as convenções REST — use GET para leitura, POST para criação, PATCH para atualização e DELETE para remoção.

Controles

Consulte os controles do seu programa de conformidade, incluindo status, responsável, frameworks vinculados e evidências associadas.

• GET /controls — lista todos os controles
• GET /controls/:id — retorna um controle específico com todos os detalhes
  
  

Evidências

Faça upload e consulte itens de evidência. Este é o caso de uso mais comum da API — por exemplo, fazer upload automático de capturas de tela, logs ou relatórios como evidências de conformidade.

• GET /evidence — lista itens de evidência
• POST /evidence — faz upload de uma nova evidência
• GET /evidence/:id — retorna uma evidência específica
  
  

Frameworks

Consulte os frameworks de conformidade ativos na sua conta, incluindo cobertura de controles e percentual de conclusão.

• GET /frameworks — lista frameworks ativos
  
  

Riscos

Leia e gerencie itens no registro de riscos da sua organização.

• GET /risks — lista todos os riscos
• GET /risks/:id — retorna um risco específico
  
  

Documentos

Acesse suas políticas e procedimentos documentados.

• GET /documents — lista documentos
• GET /documents/:id — retorna um documento específico
  
  

Fornecedores

Consulte o inventário de fornecedores (terceiros) e o status de conformidade de cada um.

• GET /vendors — lista fornecedores
  
  

Itens de Ação

Consulte itens de ação em aberto e seus status atuais.

• GET /action-items — lista itens de ação
  
  

Escopos

O acesso a cada grupo de recursos é controlado pelos escopos que você atribui à chave de API na criação. Habilite apenas os escopos que a integração realmente precisa — isso limita o impacto caso uma chave seja comprometida.

Limites de taxa

Todas as respostas da API incluem cabeçalhos de rate limit. Quando o limite é excedido, a API retorna 429 Too Many Requests. Implemente lógica de backoff exponencial com tentativas automáticas no seu código.