Desenvolvedores

Existe uma API que pode ser utilizada para a inclusão dos Rastreios. Em que situações essa API poderá ser usada?
1 - Em sites de comércio eletrônico onde você seja o desenvolvedor.
2 - Você que possui alguma empresa que alugue lojas virtuais poderá desenvolver um módulo que inclua esses rastreios automaticamente no nosso sistema.

Usando a API nos dois casos acima, você estará dando um diferencial na loja virtual onde o cliente poderá acompanhar por email a cada passo do andamento da entrega pela transportadora diminuindo a ansiedade do cliente na entrega do produto.

Veja abaixo como usar o Webservice:

URL de chamada: http://rastrearpacote.com.br/API/servicos.svc
Código de exemplo em PHP: Baixar

Para acessar o Webservice é necessário utilizar um token de segurança. Mantenha-o em segurança e não o divulgue. Lembre-se de atualizar seu sistema toda vez que gerar um novo token. Para gerar um novo token basta clicar no botão abaixo. O token aparecerá em uma caixa verde logo ao lado do botão.

É necessário estar logado para gerar o Token. Vá para a página inicial e realize o login.



Detalhes do Webservice

Métodos disponíveis: Incluir Rastreio, Editar Rastreio, Excluir Rastreio e Consultar Rastreio.

Retornos após a execução:

Todos as chamadas para os métodos retornarão um campo "Status" (0: Erro, 1: transação realizada com sucesso). Caso o retorno seja "0", é obrigatória a verificação da lista de erros (ListaErros), que é uma lista de objetos do tipo "Erro", que contém o código do erro, a descrição e o valor que foi informado.


INCLUIR RASTREIO

Objetivo: permitir a inclusão de um rastreio no sistema.

Parâmetros de Entrada:

Campo Descrição Formato Obrigatório Regras
Token Token Alfanumérico
Tamanho: 32
Sim O Token de segurança, com 32 caracteres.
CodigoRastreio Código do Rastreio Alfanumérico
Tamanho máx: 20
Sim O código do rastreio dos Correios/transportadora.
Apelido Apelido Alfanumérico
Tamanho máx: 20
Não Se preenchido, aparecerá no lugar do código do rastreio no email/Twitter.
É útil para identificar melhor qual o objeto que teve a atualização. Ex: Celular, Camisa, Tênis, Boné etc
EmailParaAlerta Email para alerta Alfanumérico
Tamanho máx: 100
Sim O email para ser avisado das atualizações do rastreio.

Mensagens de retorno:
Além de retornar os campos comuns a todos os métodos, ele também retornará o seguinte campo:

Campo Formato Obrigatório Regras
Identificador do Rastreio Alfanumérico Sim Retorna o identificador do rastreio que deverá ser usado para editar, excluir ou consultar o mesmo.


EDITAR RASTREIO


Objetivo: permitir a edição de um rastreio que esteja cadastrado no sistema.

Parâmetros de Entrada:

Campo Descrição Formato Obrigatório Regras
Token Token Alfanumérico
Tamanho máx: 32
Sim O Token de segurança, com 32 caracteres.
IdentificadorRastreio Identificador do Rastreio Alfanumérico
Tamanho: 36
Sim O identificador do Rastreio fornecido na inclusão do mesmo.
CodigoRastreio Código do Rastreio Alfanumérico
Tamanho máx: 20
Sim O código do rastreio dos Correios/transportadora.
Apelido Apelido Alfanumérico
Tamanho máx: 20
Não Se preenchido, aparecerá no lugar do código do rastreio no email/Twitter.
É útil para identificar melhor qual o objeto que teve a atualização. Ex: Celular, Camisa, Tênis, Boné etc
EmailParaAlerta Email para alerta Alfanumérico
Tamanho máx: 100
Sim O email para ser avisado das atualizações do rastreio.


CONSULTAR RASTREIO


Objetivo: permite verificar se um código de rastreio está cadastrado.

Parâmetros de Entrada:

Campo Descrição Formato Obrigatório Regras
Token Token Alfanumérico
Tamanho máx: 32
Sim O Token de segurança, com 32 caracteres.
IdentificadorRastreio Identificador do Rastreio Alfanumérico
Tamanho: 36
Sim O identificador do Rastreio fornecido na inclusão do mesmo.

Mensagens de retorno:
Retornará os campos comuns a todos os métodos (informado mais acima).


EXCLUIR RASTREIO

Objetivo: permitir a exclusão de um rastreio que esteja cadastrado no sistema.

Parâmetros de Entrada:

Campo Descrição Formato Obrigatório Regras
Token Token Alfanumérico
Tamanho: 32
Sim O Token de segurança, com 32 caracteres.
IdentificadorRastreio Identificador do Rastreio Alfanumérico
Tamanho: 36
Sim O identificador do Rastreio fornecido na inclusão do mesmo.

Mensagens de retorno:
Retornará os campos comuns a todos os métodos (informado mais acima).