API Coleta

Manual de Integração - API Coleta

Sumário

1. Glossário

Para facilitar o entendimento, listamos abaixo um pequeno glossário com os principais termos relacionados à coleta.

Termo Descrição
Autenticação  Processo de verificação de uma identidade digital do usuário, ou seja, para assegurar que o usuário é realmente aquele quem diz ser.
Autorização Processo para verificar quais são os privilégios concedidos, para utilizar uma aplicação.
Cartão de postagem Cartão que identifica um usuário como cliente de contrato dos Correios.
Código do serviço

Código dos serviços contratados pelo cliente junto aos Correios. Os códigos de serviços contratados constam do contrato comercial que o cliente firmou com os Correios.
Contrato Comercial Instrumento que o cliente firma com os Correios para a prestação de serviços de encomendas, mensagens, marketing direto e outros.
Meu Correios Mecanismo de autenticação e autorização para acesso aos serviços que os Correios disponibilizam via internet.

2. Introdução

A plataforma Coleta Interativa é uma solução para cadastro, encaminhamento e gestão de demandas de coletas dos Correios.

Este material foi desenvolvido para contribuir no planejamento e integração com o serviço de cadastro de demanda de Coletas e consulta fornecido pelos Correios.

Para quem deseja programar/agendar de forma autônoma e automatizada suas coletas, os Correios disponibilizam a API Coleta Interativa Externo (575), no qual o usuário tem total autonomia para agendamento de suas demandas e posterior consulta.

3. Acessos às APIs dos Correios.

As APIs dos Correios, possuem regras de acesso, sendo:

· API Pública: onde todos enxergam a API;

· API Restrita: o acesso é realizado a partir de habilitação do usuário externo ao componente (habilitação feita pelos Correios através do Atendente Comercial no momento do cadastro do cliente). Após a habilitação o usuário está liberado para ter acesso as APIs Restritas.

Para acessar as APIs Restritas dos Correios, o usuário deverá criar um usuário no Meu Correios: https://meucorreios.correios.com.br/

Em seguida, deverá acessar o sistema CWS e gerar um código de acesso à API: https://cws.correios.com.br/

OBS: O login no CWS é feito com o IdCorreios e a senha gerados no Meu Correios.

Caso o usuário precise de ajudar dentro do CWS no ícone “Ajuda” tem material que poderá auxilia-lo.

Caso o usuário já tenha login e senha criado no Meu Correios e tiver alguma integração via API com o Correios, não precisará gerar um novo código de acesso no CWS, ele poderá utilizar a mesma senha.

Será necessário apenas informar o idCorreios para a liberação do acesso à API restrita no IdAutorização.

Cada contrato tem sua particularidade para atender melhor cada cliente. Para visualizar as APIs liberadas no seu perfil, basta clicar na barra de pesquisa e visualizar o que está disponível.

credendiciais api coleta.png

4. Conhecendo a API Coleta Interativa Externo (575)

O acesso à API deve ser realizada pelo catálogo do Correios API. No catálogo o cliente poderá testar e acompanhar as mudanças, quando houver. O catálogo está disponível no ambiente de Homologação e Produção:

· Homologação: https://cwshom.correios.com.br/

· Produção: https://cws.correios.com.br/

5. Funcionalidades disponíveis na API

Os métodos disponíveis da API Coleta Interativa Externo (575) estão disponíveis no endereço https://cws.correios.com.br com as seguintes funcionalidades:

· Criar Coleta - Permite cadastrar clientes com contrato e registrar pedidos de coleta (Programada/Agendada).

· Consulta - Permite verificar o status das requisições (solicitações/coletas) enviadas.

A Consulta retorna para o usuário as seguintes informações:

- Número da solicitação

- Número da coleta

- Contato nome

- CEP do ponto de coleta

- Horário da coleta

- Quantidade de objetos solicitados

- Quantidade de objetos coletados Código do(s) objeto(s) coletados

Em caso de dúvidas recomenda-se utilizar como orientação os Schemas disponíveis na API dentro do CWS dos Correios.

6. Características da API

O recurso de criação de solicitações de coleta foi desenvolvido utilizando tecnologia REST. Essa tecnologia, além de padrão de mercado, pode ser utilizada em aplicações desenvolvidas em qualquer linguagem de programação, tais como: ASP, .Net, Java, PHP, Ruby, Python, entre outras.

Entre outras características, os atributos que mais se destacam na API são:

· Ausência de aplicativos proprietários: Para utilizar a API não há necessidade de instalação de um ambiente específico.

· Simplicidade: O protocolo utilizado é o HTTPS.

· Credenciais: O tratamento das credenciais do cliente trafega em ambiente seguro, sendo necessário autorização e autenticação.

· Método Síncrono: O processamento ocorre de forma sequenciada e ordenada, seguindo uma fila.

7. Pré-requisitos para utilizar API Coleta Interativa (575)

· Ter um cadastro válido no Meu Correios;

· Ter cadastrado no IdAutorização;

· Ter contrato ativo de prestação de serviços de encomendas ou mensagens com os Correios;

· O cliente deverá acessar o Correios API e criar senha de acesso

Obs.: o login no Correios API é feito com o IdCorreios e a senha gerados no Meu Correios.

· No menu do CWS, está disponível o item “Ajuda” que poderá ser auxiliar o cliente na integração

8. Considerações Finais

Este material foi desenvolvido para facilitar ao leitor o entendimento sobre a API Cadastro de Demandas do Coleta Interativa.

A API citada neste material está liberada para uso. Desta forma, caso tenham dúvidas referente à API recomendamos entrar em contato com o Assistente Comercial de sua região ou o Gestor do Contrato.

As informações técnicas sobre a integração com a API Cadastro de Demanda Externo e Consultar Coletas estão disponíveis no endereço abaixo, na aba documentação: https://api.correios.com.br/coletainterativa-externo

Informações de atendimento poderão ser obtidas por meio da nossa Central de Atendimento ou pelo site dos Correios.

Maiores informações a respeito de como realizar o acesso às APIs dos Correios estão disponíveis no Portal Correios, página de Desenvolvedores - Manual para Integração Correios APIs.