Consulta de Dados - Requisições do Tipo GET

Requisições GET em uma API são solicitações feitas para consultar dados de um servidor sem modificar seu conteúdo, retornando informações específicas conforme os parâmetros enviados na URL.

As requisições do tipo GET podem ser divididas em duas categorias: uma para consultar uma lista (você terá informações resumidas) e outra para exibir um dado específico (você tera informações mais detalhadas).

Vamos a alguns exemplos práticos:

1. Listando clientes:

Para listar os clientes da base, você deverá realizar uma requisição de Listar clientes.

Na requisição de listar clientes, você poderá passar alguns parâmetros para facilitar ainda mais a busca, sendo eles:

• Active: com esse parâmetro é possível filtrar os clientes ativos e inativos.

• Name: com esse parâmetro é possível filtrar os clientes por razão social ou nome fantasia.

• Social_revenue: com esse parâmetro é possível filtrar os clientes por CPF ou CNPJ (com ou sem os caracteres especiais).

• Offset: é o número da página que será retornada na pesquisa. Por padrão, sempre será listado os dados da página um.

• Limit: define o número de itens retornados por página na pesquisa. Por padrão, são exibidos 20 registros, mas você pode configurá-lo para retornar até 200 registros.

Segue um exemplo da requisição sendo efetuada através do Postman:

Neste caso, o retorno será da seguinte forma:

{
        "id": 1339212,
        "name": "Nome fantasia",
        "social": "Razão social",
        "social_revenue": "28120115000139",
        "status": true
    }

Sendo:

• ID: id do cliente na base.

• Name: nome fantasia do cliente.

• Social: razão social do cliente.

• Social_revenue: CPF/CNPJ do cliente.

• Status: sendo true para clientes ativos e false para clientes inativos.

2. Exibindo clientes:

Para exibir um cliente da base, você deverá consumir a rota de Exibir cliente.

Na requisição de exibir clientes, você poderá passar alguns parâmetros para facilitar ainda mais a busca, sendo eles:

• ID: deverá ser informado o id do cliente que você deseja exibir as informações. Este parâmetro é obrigatório.

• Show_entities: ao passar este parâmetro como true, serão exibidos os campos personalizados para o cliente. Por padrão, este parâmetro vem como false.

Segue um exemplo da requisição sendo efetuada através do Postman:

Neste caso, eu passei o próprio ID do cliente na URL de requisição

Neste caso, o retorno será da seguinte forma:

{
    "id": 1339212,
    "address_ids": [
        456416
    ],
    "anotations": "Anotações.",
    "authorization_flow": false,
    "billing_report_type": "detailed_with_appointment",
    "contact_ids": [
        974470
    ],
    "desk_ids": [
        46370
    ],
    "email_financial": null,
    "equipment_counter": 0,
    "estadual_registration": "920.957.900",
    "form_of_payment": "BOLETO",
    "group_counter": 1,
    "logo": null,
    "max_agents": 0,
    "municipal_registration": "123456-7",
    "name": "Nome fantasia",
    "quarterly_bill_client_id": null,
    "quarterly_billing": false,
    "sms_financial": null,
    "social": "Razão social",
    "social_revenue": "28120115000139",
    "status": true,
    "technical_group_ids": [
        39223
    ],
    "user_counter": 0,
    "user_ids": [],
    "work_folder": null
}

Para obter detalhes sobre cada rota de listagem ou exibição de dados, incluindo os parâmetros necessários e os respectivos retornos, consulte a documentação oficial da API.