Começando

Documentação da API do PipeCor

Integre o PipeCor às suas ferramentas: crie contatos e negócios, leia seus pipelines, consulte automações e receba eventos por webhook.

Visão geral

A API do PipeCor é REST, usa JSON no corpo das requisições e respostas, e é versionada. A versão atual é a v1. Toda requisição é autenticada por uma chave de API vinculada à sua conta (tenant).

URL base

url

https://app.pipecor.com/api/v1

Formato das respostas

Toda resposta segue um envelope consistente. Em caso de sucesso, ok é true; em caso de erro, ok é false e o objeto error traz code, message e, quando aplicável, details.

json

// Sucesso
{
  "ok": true,
  "data": { }
}

// Erro
{
  "ok": false,
  "error": {
    "code": "insufficient_scope",
    "message": "A chave não tem o escopo necessário.",
    "details": null
  }
}

Teste em 30 segundos

Com a sua chave de API em mãos, valide a conexão com o endpoint de health. Ele confirma a chave e devolve o tenant e os escopos associados.

bash

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

json

{
  "ok": true,
  "data": {
    "tenant_id": "9f1c...",
    "key_id": "key_01...",
    "key_name": "Integração ERP",
    "scopes": ["crm:read", "crm:write"]
  }
}

Próximos passos

Autenticação — como enviar sua chave e o que são escopos.
Erros e paginação — códigos de erro e como paginar listas.
Referência da API — contatos, negócios, pipelines e automações.

As chaves de API são emitidas pela equipe PipeCor. Para solicitar uma chave para a sua conta, fale com o suporte pelo app.