APIs Recorrência: Clientes

📘

Definições de recorrência

Certifique-se de verificar a página Recorrência com ControlPay sobre as definições de recorrência no ControlPay antes de começar a interagir com as APIs de recorrência.

Clientes

Toda recorrência pode ter o cadastro de um cliente atrelado. Abaixo as APIs para gerir clientes.

POST Cadastrar cliente

📘

{{Url}}/Cliente/Insert?key={{Key}}

Variáveis:
Url: endereço do ambiente atual.
Key: chave de acesso.

Esta API é utilizada para cadastrar clientes.

Id: Identificação da pessoa (Para atualização) - Não mandar para novos clientes;

CPF/CNPJ: CPF ou CNPJ do cliente - mandatório;

Nome/Razão Social: Nome ou razão social do cliente;

E-mail: e-mail do cliente;

Referência: identificação do cliente no sistema que está se integrando conosco;

Pessoa jurídica: true ou false, indicando se se refere a uma pessoa jurídica ou não;

HEADERS
Content-Type	application/json
User-Agent	NomeDaAutomacao/1.0

PARAMS
key	{{Key}}

JSON

{
  "cpfCnpj":"54473525848",
  "nomeRazaoSocial": "Nome",
  "email":"[email protected]",
  "referencia":"Cliente010",
  "pessoaJuridica":false
}

---

Exemplo: Cadastrar cliente

Example Request - Cadastrar Cliente

curl --location --request POST 'sandbox.controlpay.com.br/webapi/Cliente/Insert?key={{Key}}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: NomeDaAutomacao/1.0' \
--data-raw '{
  "cpfCnpj":"54473525848",
  "nomeRazaoSocial": "Nome",
  "email":"[email protected]",
  "referencia":"Cliente010",
  "pessoaJuridica":false
}'

---

POST Consultar um cliente

📘

{{Url}}/Cliente/GetById?key={{Key}}&clienteId={{ClienteId}}

Variáveis:
Url: endereço do ambiente atual.
Key: chave de acesso.
ClienteId: ID do cliente.

API para consultar um cliente específico.

HEADERS
Content-Type	application/json
User-Agent	NomeDaAutomacao/1.0

PARAMS
key	{{Key}}
clienteId	{{ClienteId}}

---

Exemplo: Consultar um cliente

Example Request - Consultar um cliente

curl --location --request POST 'sandbox.controlpay.com.br/webapi/Cliente/GetById?key={{Key}}&clienteId={{ClienteId}}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: NomeDaAutomacao/1.0' \
--data-raw ''

---

POST Consultar meus clientes

📘

{{Url}}/Cliente/GetByPessoaId?key={{Key}}&pessoaId={{PessoaId}}

Variáveis:
Url: endereço do ambiente atual.
Key: chave de acesso.
PessoaId: ID da pessoa a quem os clientes estão relacionados.

API para consultar todos clientes do estabelecimento.

HEADERS
Content-Type	application/json
User-Agent	NomeDaAutomacao/1.0

PARAMS
key	{{Key}}
pessoaId	{{PessoaId}}

---

Exemplo: Consultar meus clientes

Ecample Request - Consultar meus clientes

curl --location --request POST 'sandbox.controlpay.com.br/webapi/Cliente/GetByPessoaId?key={{Key}}&pessoaId={{PessoaId}}' \
--header 'Content-Type: application/json' \
--header 'User-Agent: NomeDaAutomacao/1.0' \
--data-raw ''