InPost Brasil. Integração e-commerce e InPost. Revisão 0.1 API 1.0 Informações Confidenciais e Proprietárias da InPost Brasil Ltda.

Transcrição

1 InPost Brasil Integração e-commerce e InPost

2 Indice Background Objetivo Descrição do fluxo do processo InPost Geo Widget Tool Web Service Authentication Autenticação Machines - Terminais Parcels - Encomendas Ciclo de Vida Descrição do Ciclo de Vida Ciclo de Vida do Cliente Ciclo de Vida do eshop e da Entrega com a InPost Suposições e Restrições

3 Objetivo A InPost oferece aos seus clientes de e-commerce, solução para integrar e permitir o envio de encomendas para os Terminais Postais de Auto-Atendimento (Lockers) da Inpost. Serviços oferecidos: - Web Service, para integração com a solução - Widget de Mapa (Geowidget), para localização / seleção de terminais O propósito deste documento é apresentar uma visão global do ciclo de vida da operação dos Lockers sob as diferentes perspectivas do serviço, e também descrever a lista de métodos do Web Service e Geowidget, permitindo a integração de clientes de e-commerce com a InPost.

4 Descrição do fluxo do processo InPost Geowidget Tool O Geowidget Inpost é uma ferramenta customizável que permite ao e-commece exibir um mapa em seu website durante o processo de finalização do pedido, para que o cliente possa selecionar o Terminal Postal de Auto-Atendimento (Locker) Inpost ao qual deseja que a encomenda seja entregue. Esta ferramenta utiliza o Widget do Google Maps. A ferramenta Geowidget é uma URL simples que pode ser incorporada ao website do e-commerce como um link simples para a URL ou em um iframe. Conteúdo desta ferramenta: - Tipo de Mapa: Permite escolher a forma de visualização do mapa (Ruas e estradas, Satelite, Hibrido ou Relevo) - Rotas: Permite ao usuário identificar o Locker mais próximo à uma rota de origem e destino informado, ou também permite ao usuário o cálculo da rota até o Locker preferencial. Os clientes podem pesquisar por Cidade, Estado ou nome do Locker; o mapa exibirá apenas os disponíveis. Os clientes poderão selecionar o Locker utilizando o mapa ou em uma lista contendo todas as unidades disponíveis. A ferramenta Geowidget então oferecerá o nome do Locker. OBS : Para que o e-commerce se integre ao sistema da Inpost, não é mandatório que use o Geowidget da Inpost. Assim, se o e-commerce já possuir alguma ferramenta Geowidget, pode dispensar o uso do Geowidget da Inpost e apenas fazer uso Webservice para obter as coordenadas e demais informações dos Lockers ativos e incorporar essa localização em seu próprio mapa.

5 Web Service O Web Service oferecido pela Inpost permite ao e-commerce enviar encomendas utilizando os Lockers InPost. Os métodos estão listados a seguir: Documentação do End-Point do WebService A InPost oferece uma documentação de mais baixo nível para desenvolvedores e analistas - contendo parâmetros de entrada e exemplos dos dados de saída no formato JSON. Essa documentação pode ser obtida no no endereço: ger.shipper.yaml Authentication Autenticação Request Type : POST Esta sessão contém o primeiro ponto de contato entre o e-commerce e o Web Service InPost. Uma vez autenticado com sucesso, então todos os métodos terão acesso concedido. Machines - Terminais Request Type : GET Esta sessão contém os seguintes métodos: - machines : Lista de Terminais: Oferece a lista de terminais. Pode ser utilizado se o eshop não escolher utilizer o WidGet Geo e obter a lista para que os clientes possam escolher. - Get machine s data : Obtém informações do Terminal: Oferece informações básicas sobre um equipamento individual, como o tipo de equipamento (se existir diferentes tipos de terminais)

6 Parcels - Encomendas Request Types : GET, PUT and POST Esta sessão contém os seguintes métodos: - Get parcel s data : Obtém dados da encomenda: Este método possui diferentes modos dependendo da conta que está requisitando a informação: CreatedAt Data de Criação Status - Situação Status Updated At Data de atualização da situação ParcelCode Código para Envio customeropencode - Código para Retirada Receiver do destinatário Receiver Name Nome do destinatário Size Tamanho [A B C] machinecode ID da máquina de destino Receiver Mobile Phone Telefone Celular do destinatário Customer Reference Referência/id do cliente no e-commerce externalid: Código de identificação da encomenda no e-commerce - Cancel a parcel: Cancelar uma encomenda: permite cancelar uma encomenda se a situação (Status) for igual à created. - Get Parcel Sticker: Obter etiqueta Adesiva: Fornece um arquivo no format PDF que contém uma etiqueta à ser impressa e colocada na encomenda para o transporte

7 Ciclo de Vida

8 Descrição do Ciclo de Vida Ciclo de Vida do Cliente - Efetua uma compra no e-commerce - Vai para a página de conclusão do pedido (contém o Geowidget) - Escolhe o Terminal Postal de Auto-Atendimento conveniente - Realiza pagamento do item no e-commerce Ciclo de Vida do eshop e da Entrega com a InPost Após o cliente completar o pagamento para o eshop, o eshop necessitará executar os seguintes passos usando o Web Service da InPost: - e-commerce cria a encomenda no sistema InPost, isso criará uma encomenda na InPost e define a situação como Created/Criado, o pacote criado agora existe no sistema InPost. - e-commerce prepara a encomenda colando a etiqueta de entrega, isso permitirá à transportadora da encomenda mudar o status para sent/coletado usando scanner de código de barra, sendo parte deste passo, o eshop necessitará imprimir uma etiqueta para o sistema InPost e então fixá-la na encomenda. A encomenda agora está pronta para o transporte. - A encomenda então será entregue para a InPost, a situação será definida como In Transit/Em Transito. Exemplo: A encomenda está em rota para o Locker Inpost. - Assim que a encomenda é inserida no Locker, a situação da encomenda é definida como Stored/Armazenado e uma notificação é enviada ao cliente por e SMS com o código de abertura e localização do Locker para então ser retirada. - Uma vez que o cliente retirou a encomenda do Locker, o status é definindo como Entregue e o ciclo de vida está concluído.

9 Observações - Alguns métodos adicionais podem ser disponibilizados como parte de futuros aprimoramentos. - Alguns métodos podem sofrer modificações como parte de futuros aprimoramentos.