Conecte seus sistemas à APREPARA e automatize suas operações.
A API da APREPARA é uma interface REST que permite que sistemas externos leiam e gravem dados diretamente na plataforma, sem qualquer interação manual. Se sua empresa utiliza um ERP, CRM ou qualquer sistema personalizado, a API permite conectá-lo à APREPARA e manter tudo sincronizado automaticamente.
Crie, atualize e consulte atividades programaticamente. Automatize o despacho e o rastreamento de status sem precisar abrir o painel web.
Leia e sincronize registros de clientes, unidades e contatos. Mantenha seu CRM e o APREPARA sempre em sincronia.
Acione ações com base em eventos em seus sistemas. Reduza a entrada manual de dados e elimine erros de redigitação de informações.
Duas funções diferentes — o mesmo objetivo: conectar sistemas de forma eficiente.
Você será a pessoa responsável por escrever o código que interage com a API. Você utilizará os endpoints diretamente da sua aplicação.
Você é responsável pelo projeto de integração. Você não precisa escrever o código, mas precisa entender o que é possível e coordenar o acesso.
A API utiliza tokens JWT Bearer para autenticação. Há duas fases: obter um token e, em seguida, utilizá-lo.
Siga estes passos para fazer sua primeira chamada de API com sucesso.
Entre em contato com a equipe de suporte da APREPARA para criar um usuário de integração para sua conta. Você receberá um nome de usuário e uma senha exclusivos para o seu sistema.
Este é um usuário diferente do seu login normal — ele se destina à comunicação entre máquinas e não deve ser compartilhado com usuários humanos.
Envie uma solicitação POST para o endpoint de login com suas credenciais de integração:
POST https://api.ltrdeo.aprepara.com/api/public/auth/login Content-Type: application/json { "username": "your-integration-username", "password": "your-integration-password" }
A API responderá com seu token de acesso:
{
"access_token": "eyJhbGciOiJIUzI1NiJ9...",
"type": "Bearer"
}
Inclua o token de acesso no cabeçalho de Autorização de cada solicitação para um endpoint privado:
GET https://api.ltrdeo.aprepara.com/api/private/{endpoint} Authorization: Bearer eyJhbGciOiJIUzI1NiJ9... Content-Type: application/json
Se o token for válido, a API retorna uma resposta JSON com os dados solicitados. Se você receber uma resposta 401, seu token expirou — vá para a etapa 4.
O token de acesso expira após 7 dias. Antes que expire, seu aplicativo deve chamar o endpoint de atualização para obter um novo token sem precisar inserir as credenciais novamente.
POST https://api.ltrdeo.aprepara.com/api/public/auth/refresh-token Authorization: Bearer eyJhbGciOiJIUzI1NiJ9... # The API returns a new access_token
Se sua aplicação estiver em execução 24 horas por dia, 7 dias por semana, implemente a renovação automática de tokens: detecte respostas 401, chame o endpoint de atualização, armazene o novo token e tente novamente a solicitação original.
A Referência Completa da API fornece documentação interativa para todos os endpoints. Você pode testar requisições diretamente no navegador após autenticar com seu token.
Você também pode baixar o arquivo de especificação OpenAPI e importá-lo para o Postman ou qualquer outro cliente HTTP para explorar toda a API offline.
Abra a Referência Completa da API para explorar todos os endpoints com documentação interativa.
Referência completa da API → Baixar JSON OpenAPITudo o que você precisa para começar a integrar.
Documentação interativa do Swagger. Navegue por todos os endpoints, teste requisições e visualize os esquemas de resposta. Requer login no painel.
Referência aberta →Baixe o arquivo JSON da OpenAPI e importe-o para o Postman, Insomnia ou qualquer cliente HTTP compatível para explorar a API localmente.
Baixar JSON →Precisa de ajuda com a integração? Abra um chamado de suporte e nossa equipe ajudará você com a configuração de acesso e dúvidas técnicas.
Abrir chamado →