Visão Geral da API

A API REST do Healthing CRM permite integrar sistemas externos e automatizar operações na plataforma.

Base URL

https://crm.healthing.com.br/api/v1

Todas as requisições devem incluir um token JWT no header:

Authorization: Bearer SEU_TOKEN_JWT

Para obter um token, use o endpoint de login. Veja Autenticação para detalhes.

Header	Valor	Descrição
`Authorization`	`Bearer {token}`	Token JWT de autenticação
`Content-Type`	`application/json`	Tipo de conteúdo
`X-Tenant-Id`	`{tenant_id}`	ID do tenant (opcional se no token)

Todas as respostas seguem o formato JSON:

{
  "data": { ... },
  "meta": {
    "page": 1,
    "per_page": 20,
    "total": 150
  }
}

{
  "detail": "Mensagem de erro",
  "code": "ERROR_CODE",
  "status": 400
}

Endpoints de listagem suportam paginação:

GET /api/v1/contacts?page=1&per_page=20

Parâmetro	Tipo	Padrão	Descrição
`page`	integer	1	Número da página
`per_page`	integer	20	Itens por página (máx: 100)

A API possui limites de requisições:

Headers de rate limit:

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640000000

A API usa versionamento via URL:

/api/v1/...  # Versão atual

Mudanças breaking serão lançadas em novas versões (v2, v3, etc.).

Oferecemos SDKs oficiais para: