Bem-vindo(a) à documentação oficial da API da Insight Academy Platform.

Esta documentação tem como objetivo fornecer todas as informações necessárias para desenvolvedores integrarem com nossos serviços de forma rápida e eficiente.

A API foi desenvolvida seguindo os princípios REST, utilizando JSON como formato padrão de troca de dados. Todos os endpoints estão organizados por recurso e utilizam os métodos HTTP adequados para cada operação.

Autenticação é feita via Chave de API no formato Bearer token, e todas as requisições devem ser realizadas sobre HTTPS.

Aqui você encontrará instruções sobre:

  • Como criar sua Chave de API
  • Autenticação
  • Códigos de status HTTP
  • Formato das requisições e respostas
  • Paginação de Listagens
  • Limites de Uso (Rate Limits)

​
URL Base da API

Todas as requisições devem ser feitas utilizando a seguinte URL base:

  https://api.plataformainsight.com.br/v1

​
Formato de Datas

Todas as datas utilizadas na API seguem o padrão ISO 8601 no formato UTC.

Isso se aplica tanto às datas enviadas nas requisições (por exemplo, em filtros ou criação de registros), quanto às datas retornadas nas respostas da API.

Exemplo de formato de data:

2025-06-15T21:06:01.000Z

​
Atualizações e mudanças na API

A API da Insight Academy pode passar por alterações em seu funcionamento, incluindo mudanças em endpoints, parâmetros, formatos de resposta ou regras de autenticação, sem aviso prévio.

É de responsabilidade do desenvolvedor que integra com a API manter-se atualizado com a documentação oficial. Recomendamos revisitar esta documentação periodicamente para garantir a conformidade com as versões mais recentes da API.