guardian api

guardian api

Guardian é uma API que possibilita o rastreamento mobile de entregas em real time através de georreferenciamento. Com a API, é possível que as empresas disponibilizem a seus consumidores o acompanhamento do status de seus pedidos e encomendas em tempo real, através de um mapa de geolocalização.

A Guardian acompanha o crescimento do setor de logística e, por isso, oferece a empresas de diversos segmentos (e-commerce, transportadoras, restaurantes, deliveries etc) melhorias nos seus sistemas de rastreamento de entregas, visando principalmente ao aumento nas vendas.

divisor

documentação

ListaEntregadores

A operação "ListarEntregadores" retorna a lista de entregadores cadastrados no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/listar-entregadores/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       Entregador 
           { 
           entNome: Rudson Figuereiro da Silva, 
           entId: 1
           }...N 
       }
        

AdicionarEntregador

A operação "AdicionarEntregador" adiciona um entregador no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/adicionar-entregador/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
entNome string (campo obrigatório) Nome do entregador.
entDescricao string (campo obrigatório) Observação relacionada ao entregador.
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       resposta 
           { 
           status:true/false
           } 
       }
        

AtualizarEntregador

A operação "AtualizarEntregador" atualiza os dados de um entregador no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/atualizar-entregador/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
entId integer (campo obrigatório) Chave individual para identificação do entregador.
entNome string (campo obrigatório) Nome do entregador.
entDescricao string (campo obrigatório) Observação relacionado ao entregador.
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       resposta 
           { 
           status:true/false
           } 
       }
        

ApagarEntregador

A operação "ApagarEntregador" apaga registro de um entregador no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/apagar-entregador/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
entId integer (campo obrigatório) Chave individual para identificação do entregador.
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       resposta 
           { 
           status:true/false
           } 
       }
        

AdicionarPedido

A operação "AdicionarPedido" adiciona registro de um pedido no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/adicionar-pedido/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
entId integer (campo obrigatório) Chave individual para identificação do entregador.
internoId integer (campo obrigatório) Chave individual interna para identificação do pedido no sistema do parceiro.
pedDescricao string (campo obrigatório) Descrição do pedido.
pedValor float (campo obrigatório) Valor total do pedido (exemplo formato – "10.50").
comNome string (campo obrigatório) Nome do comprador.
comEmail string (campo obrigatório) E-mail do comprador.
comTelefone string (campo obrigatório) Telefone do comprador (exemplo "551633719739").
comEndereco string (campo obrigatório) Endereço do comprador (exemplo "Rua César Ricomi, 49 - Jardim Lutfalla, SP, 13560-510, Brasil").
comLatitude float (campo obrigatório) Posição em latitude do endereço (exemplo formato – "-22.0050318").
comLongitude float (campo obrigatório) Posição em longitude do endereço (exemplo formato – "-47.88763979999999").
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       resposta 
           { 
           status:true/false
           } 
       }
        

ListarPedidos

A operação "ListarPedidos" retorna a lista de pedidos registrados no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/listar-pedidos/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
pedHash string Hash identificador do pedido.
entId integer (campo obrigatório) Chave individual para identificação do entregador.
internoId integer (campo obrigatório) Chave individual interna para identificação do pedido no sistema do parceiro.
pedDescricao string (campo obrigatório) Descrição do pedido.
pedValor float (campo obrigatório) Valor total do pedido.
comNome string Nome do comprador.
comEmail string E-mail do comprador.
comTelefone string Telefone do comprador.
comEndereco string Endereço do comprador.
comLatitude float Posição em latitude do endereço.
comLongitude float Posição em longitude do endereço.
comLongitude string Status do pedido.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       pedido 
           { 
            status:true/false,
            pedHash: 6345d7e5ced960f572eb8e79ba9e05ea,
            entId: 12,
            internoId: 23,
            pedDescricao: Descricao do pedido,
            pedValor: 22,50,
            comNome: Comprador Exemplo,
            comEmail: exemplo@api-guardian.com,
            comTelefone: 551633719739,
            comEndereco: Rua César Ricomi, 49 – Jardim Luffalla, SP, 13560-510, Brasil,
            comLatitude: -22.0050318,
            comLongitude: -47.88763979999999,
            pedStatus: em rota
           }...N
       }
        

ApagarPedido

A operação "ApagarPedido" apaga um pedido registrado no sistema.
Você deve especificar a KEY_PARCEIRO do vendedor para identificar a conta do parceiro.

Acesso Método Tipo de retorno
https://api-guardian.com/api/apagar-pedido/{key_parceiro} POST JSON
Parâmetros de Entrada
Campo Tipo de dado Descrição
key_parceiro string (campo obrigatório) Chave individual para identificação do parceiro.
pedHash string (campo obrigatório) Hash identificador do pedido (exemplo - 6345d7e5ced960f572eb8e79ba9e05ea).
Resposta
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
Resposta de Erro
Campo Tipo de dado Descrição
status boolean Campo para verificação de sucesso da operação requisitada.
error_code string Status code:
400 – bad request
401 – não autorizado
500 – Internal server error
503 – Service unavailable

Exemplo de Resposta

   (json) 
       { 
       resposta 
           { 
           status:true/false
           } 
       }
        
divisor

interesse

Preencha o formulário ao lado para demonstrar seu interesse em utilizar a Guardian. Em breve, sua empresa poderá contar com a API para rastreamento de seus pedidos e encomendas em tempo real. Aguarde!