API v1 · versão 2026-10-26
Integre seu sistema ao Cuidaro
A API REST do Cuidaro permite que um sistema cadastre clientes, abra e fature ordens de serviço com emissão de NFS-e, cancele e receba avisos por webhook, sempre dentro de uma empresa cliente do Cuidaro.
O que a API faz hoje
| Recurso | O que dá para fazer |
|---|---|
| Clientes | Cadastrar ou reaproveitar pelo CPF/CNPJ e consultar. |
| Ordens de serviço | Criar a OS de uma venda e consultar, inclusive a situação da NFS-e. |
| Faturamento | Faturar informando um pagamento já recebido fora do Cuidaro; o Cuidaro baixa o recebível e pede a NFS-e. |
| Cancelamento | Cancelar a OS, estornar o recebimento informado e pedir o cancelamento da nota. |
| Catálogo | Listar os serviços ativos da empresa (somente leitura). |
| Webhooks | Cadastrar endereços que recebem avisos assinados. |
Ainda não existe: busca ou listagem de OS, alteração de OS ou cliente depois de criados, cobrança gerada pela API (Pix/boleto, planejada) e download do XML da NFS-e.
Convenções
- URL base:
https://cuidaro.com.br/api/v1. - JSON na ida e na volta (
Content-Type: application/json,Accept: application/json). - Erros no formato
application/problem+json(RFC 7807), com umcodeestável. Veja Erros. - Valores em dinheiro são strings decimais (
"149.90"); datas em ISO 8601 com fuso. - Toda requisição autenticada vale para uma única empresa: a dona da credencial.
Contrato OpenAPI
O contrato completo, em OpenAPI 3.1, está em /desenvolvedores/openapi.json. Importe-o no Postman, no Insomnia ou no gerador de cliente da sua linguagem.
Referência gerada a partir do contrato OpenAPI 3.1 da API v1 (versão 2026-10-26), conferido contra o código por teste automatizado. Dúvidas: suporte@cuidaro.com.br.