Autenticação

OAuth

O primeiro passo para usar as APIs Moip é passar pelo processo de autenticação. É nessa etapa que você vai se conectar com os nossos serviços e estar apto a iniciar o desenvolvimento de sua aplicação.

Antes de mais nada, para fazer as requisições em nossas APIs, você vai precisar das chaves de acesso que estão disponíveis em sua conta sandbox. As chaves de acesso (token e key) são confidenciais e recomendamos não compartilhá-las em ambientes públicos ou com terceiros.

No caso do desenvolvimento de um marketplace a autenticação é feita através do OAuth. Nesse modo você deve autenticar usando o código access_token gerado na criação do APP. Para mais informações sobre criação do app e access_token visite a seção Marketplace Setup.

👍

DICA

Caso use o Postman você pode seguir os passos abaixo:

1. Em Authorization selecione a o type OAuth 2.0.
2. Em Headers você deve setar a key Authorization e colocar o código access_token no value.

🚧

IMPORTANTE

Para garantir uma boa formatação de texto verifique se sua aplicação está configurada para o formato ISO 8859-1.

Sempre que você realizar um método POST ou GET a API retornará o ID de criação referente àquele objeto. Este id é importante pois através dele você poderá fazer suas consultas GET, além de auxiliá-lo em seu controle organizacional. Para que você não se perca preparamos uma lista de IDs e seus respectivos significados.

ID

Objeto criado

APP-XXXXXXXXXXXX

APP/Canal Moip Connect

CUS-XXXXXXXXXXXX

Customer/Cliente

ORD-XXXXXXXXXXXX

Order/Pedido

PAY-XXXXXXXXXXXX

Payment/Pagamento

MOR-XXXXXXXXXXXX

Multiorder/Multipedido

MPY-XXXXXXXXXXXX

Multipayment/Multipagamento

ECW-XXXXXXXXXXXX

Escrow/Custódia

NPR-XXXXXXXXXXXX

Notification Preference

BKA-XXXXXXXXXXXX

Bank Account/Conta bancária

TRA-XXXXXXXXXXXX

Transference/Transferência

REF-XXXXXXXXXXXX

Refund/Reembolso

REC-XXXXXXXXXXXX

Reconciliation/Conciliação

ANT-XXXXXXXXXXXX

Anticipation/Antecipação