Primeira chamada

1. Verifique se a API responde

curl https://api.weve.cx/health

{
  "status": "ok",
  "database": { "status": "up" },
  "cache": { "status": "up" }
}

O status de cima é sempre ok quando a API responde — o que degrada é cada dependência, no próprio bloco. Um cache em down não impede a API de servir: o cache acelera, não é requisito.

2. Abra uma sessão

A credencial de quem administra é a da própria API: e-mail e senha, com o e-mail confirmado pelo link da caixa de entrada. Entrar devolve um token opaco — é ele que vai no Authorization de tudo o que vem depois.

curl https://api.weve.cx/v1/auth/admin/sign-in \
  -H "Content-Type: application/json" \
  -d '{"email":"voce@exemplo.com","password":"…"}'

{
  "data": {
    "token": "…",
    "expires_at": "2026-10-10T12:00:00Z",
    "user": {
      "id": "…",
      "name": "…",
      "email": "voce@exemplo.com",
      "verified": true
    }
  }
}

O token só aparece nesta resposta: do lado da API fica o hash dele. O dashboard o guarda em cookie httpOnly e nunca o entrega ao browser.

3. Descubra quem você é — e os seus clubs

curl https://api.weve.cx/v1/me \
  -H "Authorization: Bearer $TOKEN"

{
  "data": {
    "id": "…",
    "name": "…",
    "email": "voce@exemplo.com",
    "verified": true,
    "organizations": [
      {
        "organization_id": "5a4f2c56-…",
        "name": "Meu Club",
        "slug": "meu-club-k7pq",
        "role": "owner"
      }
    ]
  }
}

Cada organization_id é um club a que a sessão pertence, e é o valor que vai no caminho das rotas escopadas. A lista vem vazia para quem ainda não criou nem foi convidado para nenhum — POST /v1/clubs cria o primeiro.

4. Leia o club

curl "https://api.weve.cx/v1/clubs/5a4f2c56-…" \
  -H "Authorization: Bearer $TOKEN"

Pedir um club a que a sessão não pertence responde 403 com o código organization_scope — a API compara o caminho com a associação da pessoa, não com o que o cliente afirma. Um club que não existe responde igual.

Referência completa

Todos os endpoints, com os campos e os códigos de erro de cada um.

Começando

Essenciais

Primeira chamada

1. Verifique se a API responde

2. Abra uma sessão

3. Descubra quem você é — e os seus clubs

4. Leia o club

Referência completa

​1. Verifique se a API responde

​2. Abra uma sessão

​3. Descubra quem você é — e os seus clubs

​4. Leia o club

Referência completa

1. Verifique se a API responde

2. Abra uma sessão

3. Descubra quem você é — e os seus clubs

4. Leia o club