Começando

Autenticação

Toda requisição à API é autenticada por uma chave secreta vinculada à sua conta.

Enviando a chave

Envie a chave em um dos três headers aceitos. O padrão recomendado é o Authorization com o esquema Bearer.

http

Authorization: Bearer SUA_CHAVE_DE_API
# ou
x-api-key: SUA_CHAVE_DE_API
# ou
x-pipecor-api-key: SUA_CHAVE_DE_API

A chave já identifica a sua conta — você não envia o identificador do tenant nas requisições. Ele é derivado da chave. Guarde a chave como um segredo: quem tiver a chave age em nome da sua conta.

Escopos

Cada chave carrega um conjunto de escopos que limita o que ela pode fazer. Uma requisição sem o escopo exigido recebe 403 insufficient_scope.

crm:read — ler contatos, negócios e pipelines.
crm:write — criar e atualizar contatos e negócios.
automations:read — listar automações e o catálogo de gatilhos e ações.
webhooks:write — enviar eventos para a ingestão de webhooks.
* — acesso total (todos os escopos).

Erros de autenticação

401 missing_api_key — nenhuma chave foi enviada.
401 invalid_api_key — a chave é inválida, expirou ou foi revogada.
403 insufficient_scope — a chave não tem o escopo necessário para a operação.

Exemplo completo

bash

curl https://app.pipecor.com/api/v1/contacts \
  -H "Authorization: Bearer SUA_CHAVE_DE_API"

As chaves são emitidas pela equipe PipeCor com os escopos apropriados. Para solicitar, revogar ou trocar uma chave, fale com o suporte pelo app.