Verifica di un'API utilizzando lo strumento di test Developer Portal

Puoi verificare il comportamento di un'API senza dover scrivere alcun codice utilizzando lo strumento di test Developer Portal . Fornisci i parametri API necessari nello strumento di test e fai clic su Richiama per visualizzare la risposta.

Prima di iniziare

Per utilizzare lo strumento di test Developer Portal con un'API che richiede un ID client dell'applicazione, devi prima completare le seguenti attività:

Informazioni su questa attività

Lo strumento di test Developer Portal è uno strumento di test di documenti API interattivo. Se l'operazione che si desidera verificare non richiede un ID client, è possibile utilizzare lo strumento di test Developer Portal senza la necessità di eseguire l'accesso. Tuttavia, se l'operazione con cui vuoi interagire richiede un ID client, devi prima accedere a Developer Portal .

L'utilizzo dello strumento di test Developer Portal è soggetto al limite di velocità applicato a un'operazione o a un piano. Ad esempio, se un'operazione ha un limite di frequenza di 10 richieste al minuto e si richiama l'operazione, il numero di richieste che è possibile effettuare è ridotto a nove. Le limitazioni vengono attivate ogni volta che si fa clic su Richiama nell'intervallo di minuti. Questa avvertenza influisce sulla quota dell'applicazione selezionata da utilizzare con lo strumento di test Developer Portal , ma non influisce sulla quota delle altre applicazioni che utilizzano la stessa operazione o piano.

Per verificare un'API in Developer Portal, la check box Consenti il test di questa API deve essere selezionata in API Manager. Per ulteriori informazioni, vedi Creazione di definizioni API.

Limitazione:
  • Esistono meccanismi di sicurezza che ti impediscono di utilizzare lo strumento di test Developer Portal per testare un tipo di concessione Implicito o Codice di autorizzazione in un'API del provider OAuth. Altri tipi di concessione nella stessa API del fornitore OAuth può devono essere verificati. Se il provider OAuth consente a tali azioni di funzionare correttamente dallo strumento di verifica, è possibile disabilitare questa opzione. Per ulteriori informazioni, consultare Disabilitazione delle limitazioni dello strumento di test.
  • Non è possibile utilizzare lo strumento di test Developer Portal con applicazioni sospese.
  • È possibile verificare un'API non applicata solo se testable=truee se l'API esistente implementa CORS e utilizza HTTPS.
Nota: le API GraphQL possono essere verificate dall'interfaccia utente di Developer Portal . Tuttavia, non tutti i metodi di autenticazione sono supportati. È necessario utilizzare uno dei seguenti metodi di autenticazione:
  • Non protetto
  • ID client, passato nell'intestazione
  • ID client e segreto, passati nell'intestazione
Inoltre, le metriche di cost non sono supportate e i limiti di velocità specifici di GraphQL non sono elencati nei piani del prodotto.

Procedura

  1. Per utilizzare lo strumento di test Developer Portal con un'API che non richiede l'ID client di una applicazione, completa la seguente procedura:
    1. Fai clic su Prodotti API.
      Vengono visualizzate tutte le API che possono essere utilizzate dagli sviluppatori di applicazioni.
    2. Fai clic sul nome dell'API che vuoi verificare.
    3. Selezionare un'operazione e selezionare Prova.
    4. Fare clic su Prova questa operazione.
    5. Fornisci i valori per le intestazioni o i parametri richiesti.
    6. Se l'operazione è protetta con l'autenticazione di base, fornisci le credenziali.
    7. Fare clic su Invia richiesta.
      Il risultato viene visualizzato nel campo Corpo della risposta . Puoi continuare a verificare i diversi valori di parametro come necessario.
      Nota:

      La prima volta che si fa clic su Provalo, potrebbe essere visualizzato un errore di sicurezza. Copiare l'URL dal campo URL di richiesta, aprirlo in una finestra del browser e accettare il certificato di protezione. Non viene visualizzato nuovamente l'errore di sicurezza.

      Inoltre, per motivi di prestazioni, se il payload è grande, più di 1500 elementi DOM evidenziati, si ottiene la risposta, ma non è abbastanza stampato.

  2. Per utilizzare lo strumento di test Developer Portal con un'API che non richiede l'ID client di una applicazione, completa la seguente procedura:
    1. Accedi a Developer Portal.
    2. Se non lo hai già fatto, devi creare un'applicazione in modo da poter verificare un'API che richiede un ID client. Per ulteriori informazioni, consultare Registrazione di un'applicazione.
    3. assicurati che la tua applicazione sia sottoscritta al Piano che contiene l'API che vuoi testare. Per ulteriori informazioni, consultare Exploring APIs and Products in Developer Portal.
    4. Fai clic su Prodotti API.
      Vengono visualizzate tutte le API che possono essere utilizzate dagli sviluppatori di applicazioni.
    5. Fare clic sul API che si desidera verificare.
    6. Selezionare l'operazione Provide credentials for Client ID (API Key) e selezionare Prova.
      Viene visualizzata la finestra Identificazione chiave API .
    7. Utilizzare l'elenco a discesa Registra un'applicazione per selezionare un ID client per selezionare un'app con cui verificare l'API.
    8. Fare clic su Salva credenziali.
    9. Se è richiesto un segreto client, immettere il valore nel campo Segreto client .
    10. Trova l'operazione che vuoi verificare, quindi fai clic su Try It.
    11. Fornire i valori e i parametri richiesti.
    12. Se l'operazione è protetta con l'autenticazione di base, fornisci le credenziali.
    13. Fare clic su Invia.
      Il risultato viene visualizzato nella sezione Risposta. È possibile continuare a testare valori di campo differenti in base alle necessità.
      Nota: la prima volta che si fa clic su Richiama, potrebbe essere visualizzato un errore di sicurezza. Fare clic sul link fornito per accettare il certificato di protezione. Non viene visualizzato nuovamente l'errore di sicurezza.