Skip to main content
A API Pública v1.0 permite integração com o sistema ThatsMe usando API Keys. Todas as rotas requerem autenticação via Bearer Token.
Todas as rotas desta API requerem o parâmetro userCode na URL, que é o código único da empresa gerado automaticamente ao criar a primeira API Key.

​
Autenticação

Todas as requisições devem incluir o header de autenticação: 
Authorization: Bearer sua_api_key_aqui

​
GET /api/v1.0/:userCode

Retorna informações sobre a API v1.0.
​
200

​
GET /api/v1.0/:userCode/balance

Retorna o saldo de créditos da empresa autenticada. 
curl -X GET "https://api.thatsme.com.br/api/v1.0/{userCode}/balance" \
  -H "Authorization: Bearer sua_api_key"
​
200
O saldo retornado é o saldo atual de créditos da empresa. Se a empresa não tiver registro de créditos, o saldo será 0.

​
GET /api/v1.0/:userCode/winners

Lista winners (ganhadores).
​
query
object
​
issuerId
string
ID do emissor (opcional)
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
curl -X GET "https://api.thatsme.com.br/api/v1.0/{userCode}/winners?limit=10&offset=0" \
  -H "Authorization: Bearer sua_api_key"
​
200

​
GET /api/v1.0/:userCode/winner-invitations

Lista winner invitations (convites de ganhadores).
​
query
object
​
issuerId
string
ID do emissor (opcional)
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
POST /api/v1.0/:userCode/assertions

Emite uma assertion (certificado).
​
body
object
​
badge_id
string
required
ID do badge
​
event_id
string
required
ID do evento
​
recipient_email
string
required
Email do recebedor
​
recipient_name
string
required
Nome do recebedor
​
fields
object
Campos personalizados do certificado
curl -X POST "https://api.thatsme.com.br/api/v1.0/{userCode}/assertions" \
  -H "Authorization: Bearer sua_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "badge_id": "badge_123",
    "event_id": "event_456",
    "recipient_email": "[email protected]",
    "recipient_name": "João Silva"
  }'
​
201

​
GET /api/v1.0/:userCode/assertions

Lista assertions (certificados emitidos).
​
query
object
​
issuerId
string
ID do emissor (opcional)
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/assertions/:id

Retorna uma assertion específica.
​
200

​
GET /api/v1.0/:userCode/assertions/recipient/:recipientId

Retorna assertions de um recebedor específico.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/assertions/issuer/:issuerId

Retorna assertions emitidas por um emissor específico.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/winners/issuer/:issuerId

Retorna winners de um emissor específico.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/badges

Lista badges (modelos de badges).
​
query
object
​
issuerId
string
ID do emissor (opcional)
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/badges/:id

Retorna um badge específico.
​
200

​
GET /api/v1.0/:userCode/badges/issuer/:issuerId

Retorna badges de um emissor específico.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/issuers/:id

Retorna um emissor específico.
​
200

​
GET /api/v1.0/:userCode/events

Lista eventos públicos.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/events/:id

Retorna um evento específico.
​
200

​
GET /api/v1.0/:userCode/events/:id/badges

Retorna badges de um evento.
​
query
object
​
limit
number
Limite de resultados
​
offset
number
Offset para paginação
​
200

​
GET /api/v1.0/:userCode/verify/:id

Verifica a autenticidade de uma assertion.
​
200
​
200