Para desenvolvedores

Última atualização: 24 de julho de 2026

Antes de começar

A chave é criada dentro do produto, em Configurações › Entrada de dados por API, por quem administra a organização. Ela aparece uma única vez: no banco fica apenas um resumo criptográfico, e nem o suporte consegue recuperá-la. Perdeu, crie outra e revogue a anterior.

Cada chave pertence a uma organização, e é a chave que determina onde o dado entra. A organização nunca é informada na chamada — quem a resolve é o banco de dados, a partir da chave. É isso que impede uma integração mal configurada de escrever na base de outro assinante.

Autenticação

Authorization: Bearer pxm_a1b2c3d4_<segredo>

Sem cabeçalho, ou com chave inválida ou revogada, a resposta é 401. As mensagens de chave inexistente e de chave errada são iguais, de propósito.

Enviar dados

POST /api/entrada/{recurso}
Content-Type: application/json

{
  "conferencia": true,
  "linhas": [
    { "nome": "Alfa Indústria", "carteira": "RN",
      "potencial_bruto": "480000",
      "potencial_origem": "estudo tarifário",
      "potencial_data": "12/03/2026" }
  ]
}

Modo de conferência

Com "conferencia": true, nada é gravado. A resposta tem o mesmo formato e diz o que entraria e o que seria recusado, linha a linha. É assim que o sistema de origem testa antes de mandar de verdade — e recomendamos usá-lo em toda primeira carga de um recurso novo.

Resposta

{
  "modo": "gravar",
  "recurso": "contas",
  "recebidas": 120,
  "gravadas": 118,
  "recusadas": 2,
  "recusas": [
    { "linha": 14, "motivo": "carteira \"XPTO\" não existe. Cadastre-a antes.",
      "conteudo": "Beta Logística · XPTO · 90000" }
  ]
}

Linha boa e linha ruim no mesmo lote não se anulam: o que é válido entra, o que não é volta com o motivo e o conteúdo, para o seu lado corrigir sem adivinhar.

Descobrir o contrato de um recurso

GET /api/entrada/{recurso}

Devolve os campos daquele recurso, quais são obrigatórios e um exemplo pronto. Serve para a sua integração não depender desta página estar atualizada.

Recursos

carteiras — Carteiras

A primeira carga. Tudo o mais se pendura nelas.

Mínimo para criar: nome.

contas — Contas

Contas que merecem gestão individual. A carteira precisa existir antes.

Mínimo para criar: nome, carteira.

contratos — Contratos

Vigências e condições. A conta precisa existir antes.

Mínimo para criar: conta.

frentes — Frentes

Trabalho de volume agregado. A carteira precisa existir antes.

Mínimo para criar: titulo, carteira.

oportunidades — Oportunidades

Iniciativas com investimento e retorno. Informar investimento ou retorno exige dizer de onde veio a estimativa.

Mínimo para criar: titulo, carteira.

maturidade — Maturidade

Respostas de um ciclo, uma linha por carteira e pergunta. A régua e o ciclo precisam existir antes.

Mínimo para criar: carteira, ciclo, pergunta, nota.

Formatos aceitos

Limites e respostas

O que fica registrado

Toda chamada é registrada — inclusive a recusada — com data, recurso, modo, quantas linhas entraram, quantas foram recusadas e por quê. Quem administra a organização vê esse registro na mesma tela em que cria as chaves. É para que a pergunta “mandei e não entrou, por quê?” tenha resposta sem depender de log de servidor.

Exemplo completo

curl -X POST https://app.proximia.com.br/api/entrada/contas \
  -H "Authorization: Bearer $PROXIMIA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{
    "conferencia": true,
    "linhas": [
      { "nome": "Alfa Indústria", "carteira": "RN",
        "documento": "11.222.333/0001-81",
        "relacao": "contrato", "criticidade": "alta" }
    ]
  }'

O que ainda não existe

Dúvidas

contato@proximia.com.br. Se for sobre segurança da integração, veja como tratamos os dados ou escreva para seguranca@proximia.com.br.