Autenticacao

A API do GetRaze usa chaves de API para autenticar requisicoes.

Obtendo sua Chave de API

1. Faca login no painel do GetRaze
2. Navegue ate Configuracoes > Chaves de API
3. Clique em Criar Chave de API
4. Configure permissoes e limites de requisicao
5. Copie sua chave de API (ela sera exibida apenas uma vez)

WARNING

Mantenha sua chave de API segura. Nunca compartilhe em repositorios publicos ou em codigo do lado do cliente.

Usando sua Chave de API

Inclua sua chave de API em todas as requisicoes usando um dos metodos abaixo:

Header (Recomendado)

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

Bearer Token

curl --request GET \
  --url "https://app.getraze.com/external/v1/contacts" \
  --header "Authorization: Bearer gr_live_xxxxxxxxxxxxx"

Parametro de Query

curl --request GET \
  --url "https://app.getraze.com/external/v1/contacts?api_key=gr_live_xxxxxxxxxxxxx"

TIP

Recomendamos usar o header X-API-Key por seguranca. Parametros de query podem ser registrados nos logs dos servidores.

Permissoes da Chave de API

Ao criar uma chave de API, voce pode configurar permissoes granulares:

Permissao	Permite
contacts:read	Listar e buscar contatos
contacts:write	Criar e atualizar contatos
contacts:delete	Excluir contatos
opportunities:read	Listar e buscar oportunidades
opportunities:write	Criar e atualizar oportunidades
opportunities:delete	Excluir oportunidades
campaigns:read	Listar campanhas
campaigns:write	Adicionar contatos a campanhas
instagram_agents:read	Listar agentes de Instagram
instagram_agents:write	Adicionar perfis a agentes de Instagram

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

Rotacao de Chaves

Por seguranca, recomendamos rotacionar suas chaves de API periodicamente:

1. Crie uma nova chave de API com as mesmas permissoes
2. Atualize suas aplicacoes para usar a nova chave
3. Revogue a chave antiga

Erros de Autenticacao

Status	Codigo de Erro	Descricao
401	MISSING_API_KEY	Nenhuma chave de API fornecida
401	INVALID_API_KEY	Chave de API invalida ou revogada
403	INSUFFICIENT_PERMISSIONS	Chave de API sem a permissao necessaria
429	RATE_LIMIT_EXCEEDED	Muitas requisicoes