A autenticação é o primeiro passo técnico para que o seu sistema de gestão (ERP) comunique de forma segura com as APIs da TotalPass. Para garantir o sucesso da sua integração, é essencial compreender a diferença entre as credenciais exigidas e a regra de geração de tokens.
1. As Chaves de Acesso (API Keys)
Para realizar qualquer requisição de autenticação, o seu sistema precisará sempre de enviar duas chaves distintas:
partner_api_key: É a chave que identifica o seu ERP. Esta chave é gerada pela TotalPass e enviada para a sua equipa após a assinatura do Termo de Adesão. Atenção: Esta chave é estritamente confidencial e nunca deve ser partilhada ou solicitada aos seus clientes.place_api_key: É a chave que identifica a unidade (o ginásio ou estúdio do seu cliente). O seu cliente gera esta chave diretamente no Portal de Parceiros da TotalPass e insere-a na plataforma do seu ERP para concluir a ligação.
2. Endpoints e Geração do Token
Com as duas chaves em mãos, o seu sistema deve enviá-las para o nosso endpoint de autenticação. Em caso de sucesso, a nossa API devolverá os planos ativos daquela unidade na TotalPass e um Token de Acesso.
⚠️ Atenção aos Endpoints Diferentes! Apesar de as credenciais (
partner_api_keyeplace_api_key) serem exatamente as mesmas tanto para a API de Check-in como para a API de Booking, os endpoints de autenticação são diferentes.
Se vai usar a API de Booking, deve autenticar-se no endpoint específico de Booking.
Se vai usar a API de Check-in, deve autenticar-se no endpoint específico de Check-in.
3. Validade do Token
O Token gerado através da autenticação é o que permitirá ao seu sistema consumir os restantes endpoints (como a criação de webhooks ou a gestão de aulas).
O token expira a cada 24 horas. O seu código deve estar preparado para gerar um novo token sempre que este prazo terminar ou sempre que precisar de utilizar outros endpoints.
Próximos passos na documentação: Agora que já sabe como autenticar a unidade e gerar o seu token, escolha qual a API que vai integrar e consulte a documentação detalhada com todos os endpoints: