Neste artigo, explicamos como usar os endpoints para gerenciar os clientes cadastrados no painel Ideris. Você pode realizar CRUD completo (Criar, Ler, Atualizar, Deletar), especialmente para pedidos manuais, como vendas externas ao e-commerce (frente de caixa).
Endpoints Disponíveis para Clientes
1. Buscar cliente por ID
- URL: https://apiv3.ideris.com.br/client/{clientId}
- Método: GET
-
Objetivo:
Retorna os dados de um cliente específico, utilizando o ID do cliente como filtro.
2. Listar clientes cadastrados
- URL: https://apiv3.ideris.com.br/client/search
- Método: GET
-
Objetivo:
Retorna uma lista completa dos clientes cadastrados.
3. Cadastrar novo cliente
- URL: https://apiv3.ideris.com.br/client
- Método: POST
-
Objetivo:
Adiciona um novo cliente à base, ideal para pedidos manuais.
4. Atualizar cliente existente
- URL: https://apiv3.ideris.com.br/client
- Método: PUT
-
Objetivo:
Atualiza os dados de um cliente já cadastrado.
5. Deletar cliente por ID
- Método: DELETE
-
Objetivo:
Remove um cliente específico da base, utilizando o ID como filtro.
Atenção ao Excluir:
- Certifique-se de que é o cliente correto antes de deletar.
- Não há "lixeira" para recuperar registros excluídos.
Orientações Gerais para Uso dos Endpoints
- Confira a documentação do Swagger para saber:
- Campos obrigatórios.
- Formatações corretas para cada endpoint.
- Essas orientações são essenciais para evitar erros nas requisições.
Documentação Eletrônica
A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.
- Acesso: Não é necessário token para consultar essa documentação.
- Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.
Se precisar de mais ajuda com este processo, nossa equipe de suporte está pronta para atender você. É só clicar no ícone do whatsapp no canto inferior direito de qualquer página do seu painel Ideris ou abrir um ticket.
Conte sempre conosco. Até a próxima!