Referencia da API

Bem-vindo a API do GetRaze. Use nossa API REST para integrar as funcionalidades do GetRaze nas suas aplicacoes.

URL Base

https://app.getraze.com/external/v1

Autenticacao

Todas as requisicoes a API exigem autenticacao usando uma chave de API. Inclua sua chave no header da requisicao:

X-API-Key: sua_chave_api_aqui

Ou usando o formato Bearer token:

Authorization: Bearer sua_chave_api_aqui

Inicio Rapido

1. Obtenha sua Chave de API

Navegue ate Configuracoes > Chaves de API no painel do GetRaze para criar uma nova chave de API.

2. Faca sua primeira requisicao

curl --request GET \
  --url "https://app.getraze.com/external/v1/contacts" \
  --header "X-API-Key: YOUR_API_KEY"

3. Resposta

{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 150,
    "total_pages": 3,
    "has_next": true,
    "has_prev": false
  }
}

Endpoints Disponiveis

Contatos

Metodo	Endpoint	Descricao
GET	/contacts	Listar todos os contatos
GET	/contacts/:id	Buscar um contato
POST	/contacts	Criar um contato
PUT	/contacts/:id	Atualizar um contato
DELETE	/contacts/:id	Excluir um contato

Oportunidades

Metodo	Endpoint	Descricao
GET	/opportunities	Listar todas as oportunidades
GET	/opportunities/:id	Buscar uma oportunidade
GET	/opportunities/:id/history	Buscar historico de etapa/valor
POST	/opportunities	Criar uma oportunidade
PUT	/opportunities/:id	Atualizar uma oportunidade
PATCH	/opportunities/:id/stage	Atualizar estagio da oportunidade
DELETE	/opportunities/:id	Excluir uma oportunidade

Campanhas

Metodo	Endpoint	Descricao
GET	/campaigns	Listar todas as campanhas
POST	/campaigns/:id/contacts	Adicionar um contato a uma campanha

Conversas

Metodo	Endpoint	Descricao
GET	/conversations	Listar conversas (incl. qualificacao por IA)
GET	/conversations/:id	Buscar uma conversa com suas mensagens

Relatorios

Metodo	Endpoint	Descricao
GET	/reports/funnel	Funil por etapa (contagem + valor) por pipeline
GET	/reports/sales-summary	Contagens e valores de abertas / ganhas / perdidas
GET	/reports/sellers	KPIs por vendedor (receita, ticket, conversao)
GET	/reports/sla	Duracoes medias (tempo de resposta, qualificacao, ciclo)

Dados de Referencia

Metodo	Endpoint	Descricao
GET	/pipelines	Listar pipelines e suas etapas
GET	/sectors	Listar setores/times
GET	/tags	Listar tags
GET	/discard-reasons	Listar motivos de perda/descarte
GET	/products	Listar o catalogo de produtos/servicos
GET	/users	Listar membros do time (vendedores)

Agentes de Instagram

Metodo	Endpoint	Descricao
GET	/instagram-agents	Listar todos os agentes de Instagram
POST	/instagram-agents/:id/profiles	Adicionar um perfil a um agente

Limites de Requisicao

Cada chave de API possui limites de requisicao configuraveis. O padrao e 1000 requisicoes por hora.

As informacoes de limite sao incluidas nos headers da resposta:

• X-RateLimit-Limit: Maximo de requisicoes por hora
• X-RateLimit-Remaining: Requisicoes restantes
• X-RateLimit-Reset: Timestamp Unix de quando o limite reinicia

Permissoes

As chaves de API utilizam permissoes granulares:

Permissao	Descricao
contacts:read	Ler dados de contatos
contacts:write	Criar e atualizar contatos
contacts:delete	Excluir contatos
opportunities:read	Ler dados de oportunidades
opportunities:write	Criar e atualizar oportunidades
opportunities:delete	Excluir oportunidades
campaigns:read	Ler dados de campanhas
campaigns:write	Adicionar contatos a campanhas
conversations:read	Ler conversas e mensagens (incl. qualificacao por IA)
reports:read	Ler relatorios comerciais agregados (funil, resumo de vendas, vendedores)
pipelines:read	Ler pipelines e etapas
sectors:read	Ler setores/times
tags:read	Ler tags
discard_reasons:read	Ler motivos de perda/descarte
products:read	Ler o catalogo de produtos/servicos
users:read	Ler membros do time (vendedores)
instagram_agents:read	Ler dados de agentes de Instagram
instagram_agents:write	Adicionar perfis a agentes

Permissoes com wildcard sao suportadas (ex.: contacts:* concede todas as permissoes de contatos).