Pular para o conteúdo principal

Introdução

Sobre a API da Calculato​

A API da Calculato permite integrar sistemas externos à nossa plataforma de folha de pagamento completa, utilizada por empresas de diferentes portes para automatizar rotinas trabalhistas, fiscais e operacionais.

Por meio da API, é possível criar, consultar e manter dados essenciais da folha de pagamento, como empregadores, estabelecimentos, colaboradores, lotações, eventos e demais informações necessárias para o correto processamento da folha e das obrigações legais.

A Calculato foi projetada com foco em confiabilidade, conformidade legal e escalabilidade, atendendo às regras da legislação trabalhista e previdenciária brasileira, incluindo estruturas compatíveis com eSocial, FGTS, INSS, IRRF e demais encargos.

Status da API (Preview)​

⚠️ API em Preview

A API da Calculato encontra-se atualmente em fase de preview e já pode ser utilizada em integrações reais.

Isso significa que:

  • A API está disponível para uso desde já;
  • Novos endpoints, campos ou melhorias poderão ser adicionados;
  • Ajustes pontuais podem ocorrer ao longo do tempo, sempre priorizando compatibilidade e comunicação prévia.

Recomendamos que integrações críticas utilizem boas práticas de versionamento, tratamento de erros e monitoramento de mudanças na documentação.

Tipos de Integração Disponíveis​

A API da Calculato foi desenhada para suportar dois modelos claros e distintos de integração, que atendem diferentes estratégias de produto e relacionamento com o cliente final.

Esses modelos definem quem é o cliente da Calculato, quem autentica, quem controla a experiência do usuário e como a folha de pagamento é oferecida.

Integração Conectada ao Cliente (Customer‑Authorized Integration)​

Também conhecida como: Integração Conectada, Integração Autorizada pelo Cliente ou App Integrado

Este modelo é indicado para provedores de sistemas que possuem seus próprios clientes, os quais já são clientes da Calculato ou se tornam clientes da Calculato no momento da integração.

Nesse cenário:

  • O cliente final precisa ter uma conta ativa na Calculato;
  • O cliente realiza o login e autoriza a integração ao “instalar” o sistema integrador;
  • O sistema integrador passa a trocar dados diretamente com a Calculato em nome desse cliente.

Características:

  • Autenticação baseada na autorização explícita do cliente;
  • Isolamento total de dados por empregador;
  • A Calculato continua a ser a plataforma de folha utilizada pelo cliente final;
  • Ideal para integrações contínuas de dados operacionais.

Casos de uso comuns:

  • Envio de informações de horas extras, faltas, adicionais e variáveis;
  • Sincronização de cadastros (empregadores, colaboradores, lotações);
  • Recebimento de resultados de cálculos para geração de holerites;
  • Integração entre sistemas de ponto, RH ou ERP e a Calculato.

Exemplo: um sistema de ponto eletrônico que o cliente conecta à sua conta da Calculato para enviar marcações e receber os valores calculados na folha.

Integração White‑label (Embedded Payroll)​

Também conhecida como: Folha Embarcada, Payroll as a Service ou Embedded Payroll

Neste modelo, o integrador oferece funcionalidades completas de folha de pagamento aos seus clientes sem que eles precisem contratar ou acessar diretamente a Calculato.

A Calculato atua como:

  • Motor de cálculo;
  • Infraestrutura legal e fiscal;
  • Backend de folha de pagamento.

Características:

  • O cliente final não precisa conhecer ou interagir com a Calculato;
  • O integrador controla a experiência, identidade visual e jornada do usuário;
  • A Calculato opera de forma transparente como infraestrutura;
  • Ideal para plataformas que desejam oferecer folha de pagamento sem desenvolver um motor próprio.

Casos de uso comuns:

  • Plataformas de RH que incluem folha como funcionalidade nativa;
  • ERPs que desejam oferecer folha de pagamento sob sua própria marca;
  • Empresas que querem acelerar time‑to‑market com folha embarcada.

Exemplo: uma plataforma de RH que oferece folha de pagamento integrada ao produto, utilizando a Calculato como motor por trás das telas.

‼️Aprovação necessária​

Este tipo de integração funcionará inicialmente em modo provisório, permitindo o uso imediato da API.

Durante esse período, a integração será avaliada pelo time responsável da Calculato, com prazo de até 7 dias para análise e decisão.

A Calculato se reserva o direito de recusar a solicitação de integração por qualquer motivo, a seu exclusivo critério, podendo suspender ou revogar o acesso caso a integração não seja aprovada.

Considerações Importantes​

Independentemente do modelo escolhido:

  • A Calculato garante segregação lógica e segurança dos dados;
  • O escopo de acesso sempre respeita o contexto do empregador;
  • O modelo de autenticação e autorização varia conforme o tipo de integração e é detalhado na seção de Autenticação.

Princípios da API​

A API da Calculato segue princípios claros de padronização e previsibilidade:

  • Arquitetura RESTful
  • URLs orientadas a recursos
  • Entrada e saída em JSON
  • Uso consistente de códigos de status HTTP
  • Evolução contínua e versionamento controlado

Limites de taxa​

Se o seu limite for excedido, você receberá uma resposta com o código de status 429.

Além do limite de todos os planos, existe um limite de 30 chamadas de API por segundo.

Aprovação da integração​

Explore a nossa coleção no Postman​

O Postman é uma ferramenta que simplifica o desenvolvimento, teste e documentação de APIs, permitindo que você crie e compartilhe solicitações de forma rápida e segura.

Explorar Coleção