Autenticação e Autorização

Para garantir a segurança e integridade dos dados, nossa API utiliza dois tipos de autenticação: APIKeys e BearerTokens.

Tipos de Autenticação

APIKeys

A chave de API é definida no header x-api-key e está vinculada a uma empresa. Essa chave possui permissões específicas para operações de gestão, como criar novos funcionários, definir jornadas, buscar relatórios, etc. Cada chave é única para uma empresa e deve ser mantida em segurança, não sendo recomendada a sua exposição pública.

É altamente recomendado ativar a trava de IP no dashboard administrativo, pois isso aumenta a segurança da sua empresa e de seus funcionários, já que com ela é possível buscar dados sensíveis dos usuários vinculados à empresa.

Exemplo de Uso:

Esse exemplo em TypeScript realiza uma requisição buscando todos os funcionários da empresa à qual a chave de API pertence.

import axios from "axios"

const pontoDigitalApi = axios.config({
  baseURL: process.env.PONTO_DIGITAL_API_URL,
  headers: {
    "x-api-key": process.env.PONTO_DIGITAL_API_KEY
  }
})

pontoDigitalApi.get("/v1/workers")
  .then((response) => {
    console.log(response.data)
  })
  .catch((error) => {
    handlePontoDigitalError(error)
  })

PONTO_DIGITAL_API_URL="https://staging-api.pontodigital.me/api"
PONTO_DIGITAL_API_KEY="PD_KEY_FK321A1C...7XLYS4CB"

BearerToken

O token Bearer é obtido a partir do endpoint de login. Acesse a documentação das rotas de API e veja como gerar um. Com esse token, você poderá realizar a autenticação dos seus funcionários e integrar a API da forma que melhor lhe convier.

Exemplo de Uso:

Esse exemplo em TypeScript realiza uma requisição buscando os dados do usuário logado.

import axios from "axios";

const pontoDigitalApi = axios.config({
  baseURL: process.env.PONTO_DIGITAL_API_URL,
  headers: {
    "Authorization": "Bearer eyJhb...Qssw5c",
  },
});

pontoDigitalApi.get("/v1/user/me")
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(handlePontoDigitalError(error));
  });

Permissões e Operações Permitidas

Aqui estão algumas das operações permitidas para cada um dos métodos de autenticação e autorização:

APIKey

• Administrar Funcionários: Permite a leitura, criação, atualização e remoção de funcionários.

• Administrar Jornadas: Permite a leitura, criação, atualização e remoção de jornadas.

• Relatórios no Geral: Permite a visualização de relatórios de horas trabalhadas, banco de horas, entre outros recursos.

BearerToken

• Acesso a Informações do Usuário: Permite acessar e atualizar informações do perfil do usuário logado.

• Acesso a Dados Pessoais: Permite visualizar dados pessoais e registros de ponto do usuário logado.

• Marcar Pontos: Permite registrar pontos de entrada e saída do funcionário logado.

Na documentação das rotas da API, você encontrará detalhes sobre os métodos de autenticação aceitos. Leia-os para saber exatamente o que cada método de autenticação pode fazer.

---

Em caso de problemas ou dúvidas, entre em contato com [email protected].