Crear persona en Conta Azul, con una API

Crea una persona, que es cliente, proveedor o transportista según perfis. nome y tipo_pessoa son obligatorios; envía cpf para persona física y cnpj para empresa. La respuesta trae el id de la persona.

Identificador
conta_azul_create_person

La llamada

POST https://connect.reportei.com/api/tools/conta_azul_create_person/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "nome": "<nome>",
    "tipo_pessoa": "Física"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
nomestringSíName of the person or legal name of the company.
tipo_pessoastringSíFísica (individual), Jurídica (company) or Estrangeira (foreign).Valores: Física, Jurídica, Estrangeira
perfisarrayNoProfiles of the person, for example one item with tipo_perfil Cliente for a customer.
cpfstringNoCPF of an individual, for example 123.456.789-00.
cnpjstringNoCNPJ of a company, for example 12.345.678/0001-90.
nome_fantasiastringNoTrade name of a company.
emailstringNoEmail addresses of the person, separated by commas.
telefone_celularstringNoCell phone with area code, digits only, for example 11987654321.
telefone_comercialstringNoBusiness phone with area code, digits only.
codigostringNoCode of the person in your own system.
observacaostringNoNotes about the person.
enderecosarrayNoAddresses of the person.

Conexiones posibles

Tu cliente conecta su cuenta de Conta Azul una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/conta_azul, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/conta_azul_create_person. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Conta Azul

Ver las 13 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.