API Reference

A API REST do SimpleCRM permite integrar e automatizar seu CRM com outras ferramentas. Use esta referência para explorar todos os endpoints disponíveis com exemplos de requisição e resposta.

Base URL

https://crm.acessocomercial.com/api

Autenticação

Todas as requisições à API devem ser autenticadas com uma API Key. Crie sua chave na página de configurações do SimpleCRM.

Header X-API-Key

Envie sua chave em cada requisição:

X-API-Key: crm_sk_sua_chave_aqui

Alternativamente, envie como Bearer token: Authorization: Bearer crm_sk_...

Rate Limits: 60 requisições/minuto. Respostas com status 429 indicam que o limite foi atingido. Aguarde antes de enviar novas requisições.

Segurança: Rotas internas (notificações, fidelidade, gerenciamento de API keys) não estão disponíveis via API key. Use a aplicação web para essas funcionalidades.

Formato das Requisições

Envie o corpo da requisição como application/json

Datas devem estar no formato ISO 8601: 2026-05-07T10:00:00Z

IDs são strings hexadecimais de 24 caracteres (MongoDB ObjectID)

Erros retornam { "error": "descrição do erro" }

Pronto para integrar?

Crie sua conta gratuita e gere uma API Key nas configurações para começar a integrar seu CRM com suas ferramentas.

Criar Conta Gratuita