API - HGFPAY Documentação HGFPAY 2.0.
- BUSCAR CLIENTES
O método buscar clientes é para solicitar a integração dos clientes existentes no ERP para o sistema HGFPAY.
Estrutura:
- METHOD: SC.
- CNPJ: Valor do CNPJ do posto que está realizando a requisição.
{ "request_id": "{request_id}", "req": "SC|##############", "optional": "null", "date_added": "2019-12-12 15:15:18", }
Na resposta ao método buscar clientes, é necessário informar os valores para cpf_cnpj, external_id, name, cellphone, email, credit_limit, credit_limit_available, required_vehicle, required_km, required_plate dentro do parâmetro resp em formato JSON.
{ "resp": [ { "cpf_cnpj: "99999999999", "external_id: "99", "name: "Luan Magalhães Pereira", "cellphone: "99999999999", "email: "luan@hgfpay.com.br", "credit_limit: "50000.00", "credit_limit_available: "45000.00", "required_vehicle: "1", "required_km: "1", "required_plate: "1", "vehicles: [ { "plate": "AAA-0000" }, { "plate": "AAA-0001" } ], "telephones: [ "99999999999", "99999999999", ], } ] }
Estrutura:
- cpf_cnpj: CPF/CNPJ do cliente.
- external_id: Identificador do cliente no ERP para o posto.
- name: Nome do cliente.
- cellphone: Celular do cliente.
- email: E-mail de contato do cliente.
- credit_limit: Limite de crédito para o cliente.
- credit_limit_available: Limite de crédito disponível para o cliente.
- image: Imagem para o cliente (Adicional).
- birthday: Data de nascimento do cliente (Adicional, Formato: YYYY-MM-DD).
- plate: Placa do carro do cliente.
- required_vehicle: Obrigatoriedade de informar o veículo (1 para obrigatório).
- required_km: Obrigatoriedade de informar o km do veículo (1 para obrigatório).
- required_plate: Obrigatoriedade de informar a placa do veículo (1 para obrigatório).
- vehicles: Caso o cliente possua vários veículos cadastrados, pode informar as placas dos veículos neste parâmetro. (Adicional).
- telephones: Caso o cliente possua vários telefones cadastrados, pode informar os números neste parâmetro. (Adicional).