API v1 (legado)¶

Esta versão está em descontinuação

A v1 é mantida apenas para integrações já existentes. Ela não recebe recursos novos e será desligada — toda resposta traz o cabeçalho Sunset com a data.

Integração nova deve usar a v2.

Esta página guarda a documentação da v1 para quem ainda depende dela.

Autenticação¶

curl -X POST \
  'https://api-integration.checkmob.com/api/v1/auth/login' \
  -H 'accept: application/json' \
  -H 'Accept-Language: en-US' \
  -H 'Content-Type: application/json' \
  -d '{
  "login": "seu_usuario",
  "password": "sua_senha"
}'

Resposta:

{
  "success": true,
  "data": {
    "token": {
      "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
      "expiresIn": "2025-04-11T22:20:06Z",
      "tokenType": "Bearer"
    }
  }
}

accessToken — o JWT usado para autenticação
expiresIn — data e hora de expiração
tokenType — sempre Bearer

Usando o token¶

Authorization: Bearer <seu_access_token>

Paginação¶

A v1 pagina por deslocamento:

curl -X POST \
  'https://api-integration.checkmob.com/api/v1/client/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer SEU_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "numberOfRows": 500,
    "numberOfRowsSkipped": 0,
    "search": "",
    "active": true
  }'

Parâmetro	Descrição
`numberOfRows`	Quantidade máxima de registros na resposta
`numberOfRowsSkipped`	Quantos registros pular

Para navegar entre páginas:

Primeira página: numberOfRowsSkipped = 0
Segunda: numberOfRowsSkipped = numberOfRows (ex.: 500)
Terceira: numberOfRowsSkipped = numberOfRows * 2 (ex.: 1000)

Na v2 isso ficou mais simples

Você pede pagina: 3 e pronto, sem calcular deslocamento. Ver paginação.

Códigos de erro¶

Código	Descrição	Ação recomendada
200	Sucesso	Requisição processada
400	Requisição inválida	Verifique os parâmetros e o formato
401	Não autorizado	Token inválido ou expirado. Faça login novamente
429	Muitas requisições	Aguarde antes de tentar de novo
500	Erro interno	Entre em contato com o suporte

Exemplo de erro:

{
  "success": false,
  "error": {
    "code": 400,
    "message": "Parâmetros inválidos na requisição"
  }
}

Dicas¶

Use sempre HTTPS
Não compartilhe o token — ele dá acesso à sua conta
Quando expirar, obtenha um novo via login
Para 401, implemente renovação automática do token
Para 429, use retry com backoff exponencial
Mantenha log dos erros para facilitar o diagnóstico

Cabeçalhos de descontinuação¶

Toda resposta da v1 traz:

Deprecation: true
Sunset: Fri, 31 Dec 2027 23:59:59 GMT
Link: <https://docs.checkmob.com/migracao-v2>; rel="deprecation"

Se a sua integração monitora esses cabeçalhos, use o Sunset para se programar.