Getting Started

Conecte o sistema da sua academia à API de Integração do PriPass.

Bem-vindo à API de Integração PriPass — Academias

Conecte seu sistema (catraca, ERP, recepção, app) ao PriPass para check-in de
alunos por CPF
, validação de elegibilidade, consulta de planos e webhooks.

Já integra com outra plataforma de benefícios? O contrato segue o padrão de
mercado — na prática, basta apontar a base URL para o PriPass e usar suas
credenciais PriPass.

Base URL

https://api.pripass.com

Credenciais

Cada academia recebe um par de chaves (no painel PriPass, em Academia → Integração):

ChaveIdentificaEscopo
place_api_keyA academia (unidade)Única por unidade
partner_api_keyA rede/integradorCompartilhada na rede

Autenticação

São dois modos, conforme o grupo de rotas:

  1. Token (rotas administrativas /partner/*) — troque as chaves por um JWT:

    POST /partner/auth
    { "place_api_key": "place_xxxx", "partner_api_key": "partner_xxxx" }

    Use o token retornado em Authorization: Bearer <token> (expira em 24h).

  2. Header de chave (check-in) — as rotas de uso (/v1/track_usages*) e do app
    (/partner_app/v1/validate) usam direto:

    x-api-key: place_xxxx

Primeiro check-in em 2 passos

# 1) Validar (não consome)
POST /v1/track_usages/validate
x-api-key: place_xxxx
{ "type": "cpf", "identifier": "12345678900", "service_provider_code": "ACADEMIA_CENTRO" }

# 2) Registrar (consome) -> 204
POST /v1/track_usages
x-api-key: place_xxxx
{ "data": { "type": "track_usage", "attributes": {
    "type": "cpf", "identifier": "12345678900", "service_provider_code": "ACADEMIA_CENTRO" } } }

Recursos

  • Check-in — validar e registrar uso por CPF (/v1/track_usages*).
  • Beneficiário — obter o código do aluno (/v1/track_usages/beneficiaries/code).
  • Planos — planos da academia (GET /partner/plans).
  • App — elegibilidade do app (POST /partner_app/v1/validate).
  • Webhooks — eventos de check-in (/partner/webhook/*).
  • API Reference — contrato completo de cada endpoint (menu ao lado).

Precisa de ajuda?

[email protected]


Did this page help you?