Interagindo com a Mundipagg

Entenda como interagir com a Mundipagg.

• Você poderá fazer as Ações que tenham sido permitidas na instalação;
• Você receberá webhooks dos Eventos que tenham sido permitidos na instalação, na URL cadastrada para Callback de Eventos. Veja mais em Callbacks.

Utilizando a API como App (Ações)

Seu app pode realizar ações na API da Mundipagg para concluir algum processamento. Como, por exemplo: buscar um pedido de um determinado cliente.

Para isso, seu App deve ter a Permissão GetOrder na API. É necessário autenticar a requisição usando Basic Authentication passando o AccessToken da instalação criptografado em Base64 no header Authorization, como mostrado no exemplo abaixo.

Para executar esta ação seu app usará a API do Hub, enviando um GET para https://hubapi.mundipagg.com/v1/core/orders/acc_XXXXXXXXXX. O Hub vai verificar se a instalação da loja tem a Permissão para esta ação. Se for permitido, o Hub executa a requisição na API Mundipagg e retorna a resposta para o seu App. Se não for permitido, Hub retorna 401 Unauthorized para seu app.

Exemplo da requisição:

Headers
Authorization : Basic ODc5ZDAyMzU4OGJhYmE3YTgyZGE1ODkwOWExYjY2MmU0ZTU1YWE2MzQ1YzY4ZjA5MDZhYmU1ZjYwMGI2ODBhYg==

GET https://hubapi.mundipagg.com/core/v1/orders/{id}

Para este exemplo funcionar, é necessário que a permissão de ação GetOrder tenha sido dada na instalação.

Como é possível perceber, o Hub basicamente funcionará como um proxy para a API Mundipagg fazendo autorização a nível de aplicativos. Logo, todos recursos HTTP disponíveis na API Mundipagg (https://docs.mundipagg.com/v1/reference) está disponível no Hub, sendo autorizada pelas chaves das instalações e utilizando o o subdomínio https://hubapi.mundipagg.com ao invés de https://api.mundipagg.com.

Interpretando Webhooks (Eventos)

Sempre que uma loja gerar um evento escolhido no momento da instalação, a API Mundipagg enviará uma notificação para a URL de Callback de Eventos que você vai configurar em Callbacks. Essa notificação é chamada de webhook.

Exemplo: Uma loja integrou com seu app assinando o evento order.created no momento da instalação. Toda vez que essa loja receber um novo pedido, um webhook será enviado para a URL configurada.

Caso seu processamento falhe e retorne qualquer Status Code da família 5XX, como 500 Internal Server Error, esse Webhook será retentado automaticamente para seu app (10 tentativas). Retornar Status Code da família 4XX, como 400 Bad Request, não gera reenvio.

Saiba mais sobre os dados enviados no webhook na sessão de Webhook na API da Mundipagg