Introdução
Este documento descreve como validar e configurar as chamadas da API REST para o vManage através do uso da documentação integrada.
Pré-requisitos
Requisitos
Não existem requisitos específicos para este documento.
Componentes Utilizados
Este documento não está restrito a versões de software específicas ou tipos de implantação do vManage.
As informações neste documento foram criadas a partir de dispositivos em um ambiente de laboratório específico. Todos os dispositivos utilizados neste documento foram iniciados com uma configuração (padrão) inicial. Se a rede estiver ativa, certifique-se de que você entenda o impacto potencial de qualquer comando.
Acesse a documentação da API integrada
A documentação da API integrada do vManage está no URL https://<vmanage_ip>:<port:>/apidocs. Esta documentação exibe as APIs disponíveis na versão de software atual.
Isso requer login com credenciais vManage válidas. Embora vários níveis de privilégio possam exibir a documentação, apenas um usuário do netadmin pode executar todos eles.
Observação: a página de documentação da API está disponível para usuários em um ambiente multilocatário, no entanto, determinados comandos são restritos apenas ao provedor.
O vManage exibe uma lista de categorias de APIs disponíveis. Clique na categoria desejada, seguida da chamada API propriamente dita, que exibe estes campos:
| Descrição/Notas de implementação |
Descrição da operação executada. |
| Parâmetros |
Parâmetros necessários a serem especificados para a chamada à API. |
| Corpo da solicitação (POST/PUT/DELETE) |
Formato do corpo da solicitação. |
| Respostas |
Possíveis respostas que o vManage envia à API. Isso inclui o código de status HTTP, o motivo e o possível corpo da resposta. |
| Extensões |
Ramais válidos para a chamada. |
Testar APIs da Ferramenta de Documentação
As APIs disponíveis podem ser testadas por meio da opção Try It Out.
Observação: saiba que isso não é uma simulação. A chamada é realmente executada no vManage local. Planeje qualquer impacto associado de acordo.
- Clique no botão Try It Out.
- Insira todos os parâmetros necessários.
- Clique em Executar.
Esse comando executa a tarefa da API e retorna a resposta recebida do vManage, que inclui estes campos:
| URL da Solicitação |
A URL completa usada, que inclui o endereço vManage e todos os parâmetros inseridos. Isso pode ser usado por scripts ou utilitários aplicáveis que tenham sessões autenticadas com êxito. |
| Corpo da resposta |
Os dados completos da resposta recebidos. |
| Código de Resposta |
O código de status HTTP recebido. |
| Cabeçalhos de resposta |
Cabeçalhos usados. |
Informações Relacionadas
Documentação da API do Cisco Developer vManage
Feedback