Partner Integration API — Guia de Integração¶
Bem-vindo ao guia de integração da Partner Integration API, a plataforma responsável por gerenciar check-ins de alunos em assessorias esportivas e academias.
O que é esta API?¶
A Partner Integration API é o ponto central de registro de presença dos alunos. Seu sistema envia os check-ins para cá, e a plataforma valida, registra e disponibiliza os eventos para consumo.
Escopo desta documentação¶
Esta documentação cobre exclusivamente o fluxo de Check-in Interno (INTERNAL), que é o fluxo disponível para sistemas de gestão integrar diretamente com a plataforma.
Outros fluxos (integrações com parceiros externos) serão documentados separadamente quando liberados.
Endpoints disponíveis¶
| Método | Endpoint | Descrição |
|---|---|---|
POST |
/api/v1/auth/token |
Obter token de autenticação |
POST |
/api/v1/students/sync |
Sincronizar alunos (incremental) |
POST |
/api/v1/students/sync/full |
Sincronizar todos os alunos (full) |
POST |
/api/v1/checkins |
Registrar um check-in |
GET |
/api/v1/checkins/{id} |
Consultar um check-in |
Acesse
{baseUrl}/swaggerpara explorar os endpoints interativamente.
Pré-requisitos¶
Para integrar, você precisará de:
- URL da API — fornecida pela equipe de onboarding
- ClientId — identificador do seu tenant
- ClientSecret — senha de autenticação do seu tenant
Fluxo de integração¶
1. Autenticar → POST /api/v1/auth/token
2. Sincronizar alunos → POST /api/v1/students/sync/full
3. Manter sync → POST /api/v1/students/sync
4. Registrar check-in → POST /api/v1/checkins
5. Consultar status → GET /api/v1/checkins/{id}
Veja o Fluxo de Integração para detalhes de cada etapa.
Downloads¶
| Arquivo | Descrição |
|---|---|
| openapi.json | Especificação OpenAPI 3.0 — importe no Insomnia, Redoc ou Swagger UI |
| Partner Integration.postman_collection.json | Coleção Postman com todos os endpoints e scripts de automação |
| Homolog.postman_environment.json | Environment Postman para o ambiente de homologação |
Coleção Postman¶
Importe os dois arquivos acima no Postman, selecione o environment Partner Integration API — Homologação e preencha baseUrl, clientId e clientSecret.