Definições da API - Privada V2
Introdução
Nossa API 2.0 foi projetada para facilitar a integração de sistemas externos, oferecendo um conjunto robusto de endpoints para automação de processos, sincronização de dados e comunicação via webhooks.
Com suporte a autenticação segura via APP_ID e API_KEY, e um modelo avançado de permissões granulares, a API permite que você defina exatamente quais recursos podem ser acessados e modificados, garantindo maior controle e segurança.
Os webhooks possibilitam notificações instantâneas sobre eventos importantes, enquanto a validação via HMAC-SHA256 assegura a integridade e autenticidade das requisições.
A plataforma ainda fornece logs detalhados para monitoramento e diagnóstico, garantindo que cada interação seja rastreável e eficiente.
Com uma arquitetura moderna e flexível, a API V2 é a escolha ideal para plataformas que buscam escalabilidade e automação inteligente.
Autenticação
A autenticação deve ser feita utilizando os parâmetros <APP_ID> e <API_KEY> que são informados ao gerar suas credenciais de API em: Configurações > API.
Configurar a Credencial
- Nome da Credencial
No campo Nome, insira um identificador descritivo para a credencial.
- Tipo de permissão
Selecione o tipo de permissão da credencial:
- Permissão padrão: Define a permissão por nível similar ao da plataforma.
- Permissão avançada: Define permissões específicas por modelo de recurso.
Preenchido clique em Criar.
Como configurar permissões no modo Avançado
Se optar por Permissão Avançada, siga estas orientações para configurar os acessos específicos:
- A plataforma exibirá uma lista de modelos (ou categorias) de recursos, como:
- Usuário
- Matrícula
- Equipe
- Entre outros
- Para cada modelo, você poderá marcar as permissões desejadas, que incluem:
- Visualizar — permitir acesso somente leitura
- Criar — permitir a criação de novos registros
- Atualizar — permitir alterações em registros existentes
- Excluir — permitir remoção de registros
- Outras permissões específicas conforme o modelo
⚠️ Importante: Selecione apenas as permissões necessárias para garantir a segurança da integração.
Estes parâmetros devem ser informados no HEADER da requisição, no seguinte formato:
HEADER = {
Content-Type: application/json,
app-id: "LTHDT9EQIXXXXXXXXXXXXXXXXISZYXR",
api-key: "ZUXXXXXXXXXXXXXXXXXXXXnRyGPD"
}
Endpoints
O endpoint base para as requisições da API V2 é: https://<sua_plataforma>/api/v2
Toda a documentação sobre os endpoints, exemplos de requisições e exemplos de respostas estão dentro da documentação em sua plataforma.
Você pode acessar esta documentação exclusiva da sua plataforma indo em: Configurações > API, então clique no botão Documentação.
Qualquer dúvida estamos à disposição em nosso suporte ao vivo.
Atualizado em: 19/06/2025