APIPreçosDocumentaçãoBlogParceirosContato

Primeiros Passos

Conecte seu primeiro dispositivo em menos de 15 minutos.

Pré-requisitos

Antes de começar, você precisará de:

  • Uma conta PunchConnect ()
  • Um dispositivo biométrico com protocolo ZKTeco
  • O número de série do seu dispositivo

Como Funciona

O PunchConnect é uma REST API. Você interage com ele usando requisições HTTP — sem necessidade de SDK. Use Postman, cURL ou qualquer cliente HTTP na linguagem de sua preferência (PHP, Python, Node.js, etc.).

URL Base: https://api.punchconnect.com/api/v2/zk

Liste Seus Dispositivos

Depois que seus dispositivos forem registrados pelo painel, use a API para listá-los e começar a interagir.

bash
curl https://api.punchconnect.com/api/v2/zk/devices \
  -H "X-CLIENT-ID: your_client_id" \
  -H "X-CLIENT-SECRET: your_client_secret" \
  -H "Accept: application/json"

Autenticação

Todas as requisições à API são autenticadas usando dois headers: seu ID de cliente e segredo de cliente. Obtenha-os no painel do PunchConnect.

HeaderDescrição
X-CLIENT-IDSeu ID de cliente da API
X-CLIENT-SECRETSeu segredo de cliente da API
Content-Typeapplication/json
Acceptapplication/json

Códigos de Erro

O PunchConnect usa códigos de status HTTP padrão. Todos os erros retornam um corpo JSON consistente.

json
{
  "error": {
    "code": "device_not_found",
    "message": "No device found with serial CZKT2024099",
    "status": 404
  }
}
StatusSignificado
200Sucesso
201Criado
400Requisição inválida — verifique seus parâmetros
401Não autorizado — chave de API inválida ou ausente
404Não encontrado — recurso não existe
429Limite de requisições excedido — reduza a frequência
500Erro no servidor — tente novamente ou contate o suporte

Próximos passos

Primeiros Passos | PunchConnect