API API API API API API API API API API API API API API API API API API API API API API API Criando uma chave de API

Criando uma chave de API

Megaport As chamadas da API da Megaport exigem um token de acesso que você pode gerar após criar uma chave de API. Um token de acesso é necessário para autenticar usuários de API e permite acesso temporário apenas às partes do Megaport Portal que são necessárias.

Recomendamos usar uma conta dedicada, de máquina a máquina (M2M), Company Admin para acessar a API da Megaport e criar chaves de API. Caso um usuário humano seja desativado ou fique sem acesso à conta, as chaves de API criadas por esse usuário também serão suspensas, o que pode interromper o funcionamento de integrações de API.

As chaves de API são válidas apenas no ambiente em que foram geradas. Se você precisar de chaves de API para acessar um ambiente diferente, faça login no Megaport Portal desse ambiente e gere as chaves de API lá.

Nota

Você deve estar conectado ao Megaport Portal como Company Admin para criar uma chave de API. Para obter mais informações, consulte Gerenciando funções de usuário.

Este tópico descreve as seguintes tarefas:

Para criar uma chave de API no Megaport Portal
Para gerar um token de acesso no Postman

Para criar uma chave de API no Megaport Portal

No Megaport Portal, escolha Tools > API Key Generator.
A tela API Keys permite criar chaves de API e visualizar e editar chaves de API existentes.
Especifique os detalhes da chave de API.
- Nome – Insira um nome para a chave de API.
  Deve ser um nome descritivo para identificar a finalidade da chave.
  Nota
  - É necessário um mínimo de três caracteres para o nome da chave de API.
  - Nenhum caractere especial é permitido, exceto traço e hífen.
- Função – Selecione a função do usuário que utilizará a API.
  As seguintes opções estão disponíveis:
  - Company Admin
  - Read Only
- Expiração do token (minutos) – Insira a quantidade de tempo (em minutos) após a qual o token gerado a partir desta chave expirará. O mínimo é 5 minutos e o máximo é 24 horas (1440 minutos). Depois que o token expirar, você precisará gerar um novo token de acesso.
Clique em Gerar chave.
A chave de API é criada e o prompt Your API Key é exibido.

Importante

Copie sua nova API Key e API Key Secret e armazene essas credenciais em um local seguro. Você precisará usá-las para gerar tokens de acesso. Certifique-se de copiar o API Key Secret, pois ele não será mostrado novamente depois que você fechar este prompt.
Clique em Copiar à direita do campo Chave de API e cole a chave (Client Id) em um local seguro.
Clique em Copiar à direita do campo Segredo da chave de API e cole o segredo do cliente em um local seguro.
Clique em Fechar.
A chave de API é criada e exibida na área Active API Keys da tela.
Na área Active API Keys, você pode editar o nome da chave, excluir a chave e visualizar o histórico de alterações que ocorreram para a chave.

Gerando um token de acesso

Depois de criar a chave de API, composta por um ID do cliente e um segredo do cliente, você pode gerar um token de acesso para autenticar usuários de API. Estas instruções descrevem como fazer isso usando o Postman e a coleção da Megaport. Para detalhes sobre a configuração do Postman, consulte Megaport API.

A URL da solicitação que você precisa usar depende do ambiente em que você está gerando um token de acesso. Em cada ambiente, estas URLs de solicitação devem ser usadas:

Ambiente de produção – https://auth-m2m.megaport.com/oauth2/token
Ambiente de staging (teste) – https://auth-m2m-staging.megaport.com/oauth2/token

Estas instruções descrevem como gerar um token de acesso no ambiente de produção. Para obter mais informações, consulte Megaport API e Megaport Authentication - API Keys.

Nota

Quais endpoints de API um token de acesso pode chamar depende da função selecionada para a chave de API quando ela foi criada. Por exemplo, chaves de API Read Only terão mais restrições aos dados que podem ser acessados do que chaves de API Company Admin.

Para gerar um token de acesso no Postman

Na coleção importada da Megaport no Postman, clique no ícone de mais para adicionar uma nova solicitação.
Na lista suspensa à esquerda do campo URL da solicitação, selecione POST.
No campo URL da solicitação, insira a seguinte URL de solicitação:
https://auth-m2m.megaport.com/oauth2/token
Selecione a guia Autorização e insira os seguintes detalhes de parâmetro:
- Nome de usuário – O ID do cliente que você copiou anteriormente ao criar a chave de API.
- Senha – O segredo do cliente que você copiou anteriormente ao criar a chave de API.
Nota

Esses parâmetros contêm dados confidenciais. Se você estiver trabalhando em um ambiente colaborativo, talvez queira definir o ID do cliente e o segredo do cliente como as variáveis {{apiKeyClientId}} e {{apiKeyClientSecret}}, respectivamente. Para mais informações sobre variáveis, consulte a documentação do Postman.
Selecione a guia Body e insira uma chave chamada grant_type, definida com o valor client_credentials.
Clique em Salvar.
A tela Save Request é exibida.
No campo Nome da solicitação, insira um nome significativo para a nova solicitação.
Por exemplo, Gerar token de acesso.
(Opcional) Insira uma descrição da solicitação.
Selecione onde você gostaria de salvar a solicitação e clique em Salvar.
A nova solicitação é criada e adicionada à coleção Megaport API Documentation.
Clique em Enviar.

Você deverá receber uma resposta que inclui seu token de acesso, semelhante ao exemplo abaixo. Depois que um token de acesso é gerado, ele pode ser usado para autenticar usuários de API para vários endpoints no Megaport Portal.
```
 {
  "access_token":  
      "eyJraWQ......2cOQGA",
  "expires_in": 86400,
  "token_type": "Bearer"
 }
```
Copie o token de acesso.
Nas variáveis da coleção (clique nos três pontos após a coleção importada da Megaport > Edit > Variables), adicione uma entrada para access_token e cole o token de acesso no campo VALOR ATUAL.
Para cada chamada de API que você precisar enviar, na guia Autorização, o Type deve ser definido como Bearer Token e o Token deve ser definido para a variável de token de acesso {{access_token}}.

A chamada de API agora está pronta para uso. Todas as chamadas de API são feitas sobre SSL/TLS, e cada chamada é validada em relação ao token de acesso para as permissões apropriadas.

Nota

Os tokens de acesso expiram, portanto você precisa gerar novos tokens regularmente para suas chamadas de API. O período de expiração é determinado pelo valor inserido no campo Expiração do token (minutos) quando a chave de API foi criada. O período de expiração padrão é de 24 horas.

As solicitações de API incluem dois parâmetros de cabeçalho importantes: Authorization e Content-Type. O parâmetro Authorization aponta para a guia Authorization onde a variável de token é definida.

Cabeçalhos obrigatórios

Geração de token com cURL

Outra forma de gerar um token de acesso é usando cURL a partir de um console de comandos no seguinte formato:

 curl -X "POST" "https://auth-m2m.megaport.com/oauth2/token" \
        -H 'Content-Type: application/x-www-form-urlencoded' \
        -u '<api_key>:<api_key_secret>' \
        --data-urlencode "grant_type=client_credentials"

Dica

O site dev.megaport.com permite ver cada endpoint de API em várias linguagens de programação.