Acessibilidade Português
Ir para o conteúdo (alt+1) Ir para o menu (alt+2) Ir para o rodapé (alt+3) Libras Saiba mais sobre acessibilidade

FAQ

Passos necessários para acessar os componentes:

1 - Cadastrar usuário Pessoa Jurídica

2 - Cadastrar senha para componente

3 - Consumir o componente pelo Portal

4 - Buscar token do componente POSTMAN

5 - Consumir o componente pelo POSTMAN

6 - Observações

1 - Cadastrar usuário Pessoa Jurídica

Para cadastrar um usuário Pessoa Jurídica:

a) Acesse o endereço do idCorreios e clique sobre o botão [Cadastrar-se no idCorreios], destacado na imagem abaixo:

b) O idCorreios apresentará as opções de perfis disponíveis. Selecione a opção de perfil “Pessoa Jurídica” para cadastrar uma empresa. Em seguida, pressione o botão [Prosseguir].

c) O idCorreios apresentará o formulário de cadastro para preenchimento, no qual o usuário deve iniciar com a informação de CNPJ da empresa para a qual o cadastro está sendo realizado. Caso o CNPJ já possua contrato com os Correios, basta informar o número docontrato que os dados serão preenchidos conforme as informações cadastradas nos Correios.

ATENÇÃO: Os Correios não podem alterar as informações cadastradas pelos usuários. Em caso de perda de acesso (nome de usuário e/ou senha), existem procedimentos para recuperá-lo por meio de envio de instruções por e-mail que possibilitam a recuperação destes dados.

Assim, orientamos os nossos usuários a informar um endereço de e-mail que possa ser acessado por mais de uma pessoa da empresa, de modo que seja possível recuperar nome de usuário e a senha do idCorreios, mesmo que a pessoa que realizou o cadastro tenha se perdido acesso àquele endereço de e-mail.

Se o cliente não for capaz de realizar estes procedimentos por falta de acesso ao e-mail utilizado, os Correios poderão cancelar o cadastro, liberando o CPF/CNPJ para se cadastrado novamente.

Para prosseguir, leia o termo de uso dos serviços e marque a caixa de seleção destacada na imagem anterior. Em seguida, pressione o botão [Prosseguir].

2 - Cadastrar senha de acesso ao token do componente

Para se ter acesso ao token do componente deverá ser cadastrada um senha distina à senha informada no no item 1 - Cadastrar usuário Pessoa Jurídica.

a) Acesse o endereço do idCorreios e entre com o usuário idCorreios e a senha de acesso informados no item 1 - Cadastrar usuário Pessoa Jurídica.

b) Selecione a opção "Componentes com permissão de acesso recebida" (destaque na imagem a seguir):

c) Marque na tela abaixo a caixa de seleção destacada na imagem que habilita os campos de senha e confirmação de senha de acesso aos componentes.

d) Em seguida, digite a senha e a confirmação da senha nos campos indicados e pressione o botão [Alterar]. A senha informada será utilizada para acesso a todos os componentes aos quais o idCorreios possui acesso.

3 - Consumir o componente pelo Portal

É possível consumir um componente por meio de requisição com autenticação utilizando Token.

Abaixo um exemplo de consumo de componente utilizando o Portal:

a) Selecione o item de menu "Documentação" e posicione o cursor no campo de pesquisa. Os componentes liberados para seu idCorreios aparecerão na lista. Escolha o componente que irá consumir. No nosso exemplo escolhemos o componente chamado "Preço e Prazo - Preço".

b) Escolhido o componente, clique no botão "Credenciais".

c) Digite o usuário, senha de acesso a componentes e o cartão de postagem (caso se aplique). Ao clicar no botão "Gerar Token", o Token de autenticação será apresentado no campo "Token". Neste ponto, esta tela já pode ser fechada.

d) Escolha o recurso que irá utilizar, no nosso exemplo escolhemos o recurso "Consulta preço de um produto/serviço" e clique no botão "Try it out".

e) Informe os parâmetros do recurso conforme a necessidade e clique no botão "Execute".

4 - Buscar token do componente pelo POSTMAN

Com o usuário idCorreios cadastrado no item 1 - Cadastrar usuário Pessoa Jurídica e a senha de acesso ao token cadastrada no item 2 - Cadastrar senha de acesso ao token do componente é possível buscar o token.

Abaixo um exemplo de busca do token utilizando o postman:

a) Faça uma requisição POST ao endereço https://api.correios.com.br/token/v1/autentica/cartaopostagem (ou endereço https://api.correios.com.br/token/v1/autentica caso não esteja utilizando cartão de postagem) utilizando o idCorreios em username e a senha do item 2 - Cadastrar senha de acesso ao token do componente em password:

b) Caso esteja utilizando um cartão de postagem, informe o número do cartão de postagem no body da requisição conforme abaixo:

c) Agora basta clicar em SEND e o token para acesso aos componentes autorizados será retornados:

d) Exemplo de retorno:

5 - Consumir o componente pelo POSTMAN

De posse do token é possível consumir um componente por meio de requisição com autenticação Bearer token.

Abaixo um exemplo de consumo de componente utilizando o postman:

a) Na requisição ao componete selecione a autenticação Bearer token e no campo Token informe o token que foi obtido no item 4 - Buscar token do componente pelo POSTMAN

6 - Observações

Os componentes possuem uma limitação de taxa (rate limiting) de 150 requisições por segundo por usuário.