Começando

Introdução

A API Customer V2 é a interface oficial para integrações externas com o iopoint. Use-a para sincronizar colaboradores, registrar batidas de ponto, consultar afastamentos e exportar relatórios de jornada.

Quem deve usar essa API

Sistemas de folha de pagamento, ERPs, plataformas de RH e integrações internas que precisem ler dados de jornada ou registrar eventos no controle de ponto.

URL base

Todas as requisições partem da URL abaixo. Cada endpoint da documentação informa o caminho relativo a partir de /customer/v2.

https://api.iopoint.com.br/api/customer/v2

Primeira requisição

O exemplo abaixo busca os dados cadastrais da sua empresa — é o jeito mais rápido de validar o token.

curl -X GET "https://api.iopoint.com.br/api/customer/v2/company" \
  -H "apiIopointToken: SEU_TOKEN_AQUI"

Dica

Comece pelos endpoints GET de listagem (company, journey, department, unit). Eles não modificam dados e ajudam a entender a estrutura antes de criar colaboradores ou registrar pontos.

Versionamento

Esta documentação cobre a V2. A V1 (/customer sem versão) ainda responde, mas está em descontinuação — novas integrações devem usar exclusivamente a V2.

API V1 em descontinuação

Não construa novas integrações sobre a V1. Endpoints sob /api/customer/... sem o prefixo v2 serão removidos em versões futuras.

Collection Postman

Baixe a collection abaixo e importe no Postman ou Insomnia para testar todos os endpoints com um clique. As variáveis base_url e apiIopointToken já vêm pré-configuradas.

Baixar collection (.json)

Próximos passos

Leia Autenticação para entender como obter e enviar o token.
Em Convenções você encontra o envelope de resposta, tratamento de datas e limites de período.
A seção Referência (sidebar) lista todos os recursos com seus endpoints.