Utilizando Postman para testar as APIs da Senior Mega

Requisitos

Todos os requisitos abaixo devem ser atendidos para realização dos testes:

• Acesso à internet
• Instalação Postman

Clique aqui para realizar o download da ferramenta Postman.

Informações 

Configuração

1. Acesse o site dev.mega.com.br, selecione na Biblioteca de APIs a qual deseja utilizar e copie o endereço do json dela:

2. Acesse a ferramenta Postman;

3. Clique em Import;

4. Insira o endereço que foi copiado no passo 1;

5. Após a importação do json, basta acessar a aba Collections e identificar a API importada.

Gerando Token de acesso 

O Token de segurança é necessário para a comunicação de todas as APIs da Senior Mega. Ele é provido através de uma autenticação das seguintes informações: TenantId, Usuário do Mega que irá acessar as APIs e Senha desse mesmo usuário.

1. Selecione a API de Token de acesso (Autenticação APIs, a mesma usada no exemplo de Configuração);

2. No diretório Autenticação APIs, insira o endereço das APIs. Para isto, na aba Variables na linha baseUrl, preencha as colunas Initial Value e Current Value com o endereço das suas APIs: https://rest.megaerp.online (Mega Cloud) ou o que foi definido para o seu ambiente (Como ativar e utilizar as APIs disponíveis no Mega ERP);

3. Salve suas alterações clicando no botão Save;

4. Selecione a API “Post Autenticar Usuario”;

5. Na aba Header, insira a Key tenantId e preencha com o valor do seu tenant;

Para saber mais sobre o tenant, acesse o artigo Como utilizar APIs dentro do SaaS Mega [Mega Cloud].

6. Na aba Body, substitua no JSON os valores, userName e password pelos dados do usuário do Mega que será utilizado nos acessos de APIs;

Caso ainda não tenha sido feito é necessário configurar o usuário do Mega que terá permissão de consumir as APIs. Na tela de Cadastro do Usuário, selecione a opção "Usuário de APIs" e clique em Confirmar.

7. Com os parâmetros preenchidos, clique em Save e em seguida clique em Send;

⚠️O sistema gerará um Token de acesso no Body, com validade de 2 horas.

8. Guarde as informações do Token e do RefreshToken para uso nas APIs de integração do sistema.

Utilizando as APIs

Neste capítulo será descrito quais dados básicos precisam ser inseridos em uma API para consumi-la.

1. Na API desejada selecione o diretório principal dela, na aba Variables, insira novamente o endereço para consumo das APIs e clique em Save;

2. Selecione agora a API que deseja consumir, na aba Authorization, mude o combo box para Bearer Token e preencha com o valor do token de acesso obtido na API de autenticação;

3. Se for uma API que não exige outros valores (isso estará na documentação específica de cada API), clique em Send para receber o retorno dela.