Clientes

APIs relacionadas à gestão de Clientes na plataforma.

🚧

Antes de usar as APIs...

Certifique-se de ter verificado as secções de APIs e Chave de Integração, além de ter lido as nossas Informações preliminares.

Gestão de clientes

Esta lista de APIs serve para a gestão de clientes dentro da plataforma ControlPay, sendo estes clientes atrelados a uma Pessoa. Clientes não são compartilhados entre usuários ControlPay, garantindo a privacidade dos mesmos.

POST Cliente/Insert

📘

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

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

API para registrar um cliente para uma pessoa.

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

PARAMS
key	{{Key}}

BODY raw

{
  "id":"",
  "cpfCnpj":"12345678909",
  "nomeRazaoSocial": "Cadastro Cliente",
  "email":"[email protected]",
  "referencia":"cliente",
  "pessoaJuridica":true,
  "pessoaId":"",
  "endereco": {
            "TipoLogradouro" :"Rua",
            "Logradouro" :"Fidêncio Ramos",
            "Numero" :"100",
            "Complemento" :"CJ 2",
            "Cep" :"04551-010",
            "Bairro" :"Vila olímpia",
            "Cidade" :"São Paulo",
            "Uf" :"SP"
        }
}

---

Exemplo: Cliente/Insert

Example Request - Cliente/Insert

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 '{
  "id":"",
  "cpfCnpj":"12345678909",
  "nomeRazaoSocial": "Cadastro Cliente",
  "email":"[email protected]",
  "referencia":"cliente",
  "pessoaJuridica":true,
  "pessoaId":"",
  "endereco": {
            "TipoLogradouro" :"Rua",
            "Logradouro" :"Fidêncio Ramos",
            "Numero" :"100",
            "Complemento" :"CJ 2",
            "Cep" :"04551-010",
            "Bairro" :"Vila olímpia",
            "Cidade" :"São Paulo",
            "Uf" :"SP"
        }
}'

---

POST Cliente/GetByPessoaId

📘

{{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 o cliente pertence.

API utilizada para consultar os clientes de uma pessoa.

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

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

---

Exemplo: Cliente/GetByPessoaId

Example Request - Cliente/GetByPessoaId

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 ''

---

POST Cliente/GetById

📘

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

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

API utilizada para consultar um cliente de uma pessoa.

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

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

---

Exemplo: Cliente/GetById

Example Request - Cliente/GetById

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 ''