Sommario

Introduzione

Prerequisiti

Requisiti

Componenti usati

Documentazione sull'API di AccessOnboard

Test delle API dallo strumento di documentazione

Informazioni correlate

Introduzione

In questo documento viene descritto come convalidare e configurare le chiamate API REST a vManage tramite l'utilizzo della documentazione integrata.

Prerequisiti

Requisiti

Nessun requisito specifico previsto per questo documento.

Componenti usati

Il documento può essere consultato per tutte le versioni software o per tutti i tipi di distribuzione di vManage.

Le informazioni discusse in questo documento fanno riferimento a dispositivi usati in uno specifico ambiente di emulazione. Su tutti i dispositivi menzionati nel documento la configurazione è stata ripristinata ai valori predefiniti. Se la rete è operativa, valutare attentamente eventuali conseguenze derivanti dall'uso dei comandi.

Documentazione sull'API di accesso integrato

La documentazione dell'API onboard di vManage è disponibile all'URL https://<vmanage_ip>:<porta:>/apidocs.  In questa documentazione vengono visualizzate le API disponibili nella versione software corrente.

È necessario eseguire l'accesso con credenziali vManage valide.  Sebbene più livelli di privilegi possano visualizzare la documentazione, solo un utente netadmin è in grado di eseguirli tutti.

Nota: la pagina della documentazione dell'API è disponibile per i tenant in un ambiente multi-tenant; tuttavia, alcuni comandi sono limitati al solo provider.

vManage visualizza quindi un elenco di categorie di API disponibili.  Fare clic sulla categoria desiderata, seguita dalla chiamata API stessa che visualizza i campi riportati di seguito.

Note sulla descrizione/implementazione

Descrizione dell'operazione eseguita.

Parametri

Parametri obbligatori da specificare per la chiamata API.

Corpo richiesta (POST/PUT/DELETE)

Formato del corpo della richiesta.

Risposte

Possibili risposte inviate da vManage all'API.  Sono inclusi il codice di stato HTTP, il motivo e il possibile corpo della risposta.

Interni

Estensioni valide per la chiamata.

Test delle API dallo strumento di documentazione

Le API disponibili possono essere testate tramite l'opzione Try It Out.

Nota: questa non è una simulazione. La chiamata viene effettivamente eseguita sul vManage locale.  Pianificare di conseguenza l'eventuale impatto associato.

1. Fare clic sul pulsante Prova.

2. Immettere tutti i parametri obbligatori.

3. Fare clic su Execute.

Questo comando esegue l'attività API e restituisce la risposta ricevuta da vManage, che include i campi seguenti:

URL richiesta

L'URL completo utilizzato, che include l'indirizzo vManage e gli eventuali parametri immessi.  Può essere utilizzato da script o utility applicabili che hanno autenticato correttamente le sessioni.

Corpo risposta

Dati di risposta completi ricevuti.

Codice di risposta

Codice di stato HTTP ricevuto.

Intestazioni risposte

Intestazioni utilizzate.

Informazioni correlate

Documentazione sull'API Cisco Developer vManage