Skip to main content

Come usare Postman

Puoi utilizzare Postman per testare l'API Server V3.

Prerequisiti:

  • È necessario che Postman sia installato. Postman è disponibile all'indirizzo go.postman.co/home .

  • Devi disporre di una chiave API e di una chiave privata API per testare l'API Server in Postman. Per ulteriori informazioni, consulta la pagina di assistenza Ruoli utente e autorizzazioni .

Aggiunta dell'API a Postman

Per testare l'API Server, devi importarla in Postman.

  • Innanzitutto, devi recuperare il collegamento che utilizzerai per importare l'API Server V3. Per trovare questo collegamento, accedi all'interfaccia utente di Server, seleziona l'icona con il punto interrogativo nell'angolo superiore destro, quindi scegli Documentazione API . Viene visualizzata la pagina API Swagger V3.

  • Prendi nota dell'indirizzo della documentazione API presente nella pagina di Swagger.

    Note the address of the API documentation you find on the Swagger page. 

  1. In Postman, accedi a Raccolte e seleziona Importa .

  2. Seleziona Collega , immetti l'URL dell'API Server annotato al passaggio 2 , quindi seleziona Continua .

  3. A questo punto, l'API Alteryx Server V3 è visibile nella scheda Raccolte .

Impostazione dell'autorizzazione

Per inviare le richieste, devi impostare l'autorizzazione in Postman.

  • Accedi a Raccolte e seleziona API Alteryx Server V3 .

  • Nella scheda Aut , seleziona Oauth 2.0 in Tipo.

  • Imposta il Token corrente come segue:

    AD273A073BE2399E360B94B3F9EB79C6.png

  1. Nella sezione Configura nuovo token , imposta quanto segue:

    1. Facoltativamente, immetti un Nome token .

    2. In Tipo di concessione , seleziona Credenziali client .

    3. In URL token di accesso , specifica l'endpoint per il server di autenticazione. Per individuare l'endpoint, accedi a Swagger e cerca l' URL del token . Per ulteriori informazioni, consulta la sezione Come eseguire l'autenticazione nella pagina di assistenza Configurazione e autorizzazione dell'API .Configurazione e autorizzazione dell'API Server

      Find the Token URL in Swagger.

      Esempio di configurazione del token finale:

      How the API authorization looks like in Postman.

    4. In ID client , immetti la Chiave di accesso API indicata in Profilo personale nell'interfaccia utente di Server.

    5. In Chiave privata client , immetti la Chiave privata API riportata in Profilo personale nell'interfaccia utente di Server.

    6. In Autenticazione client , seleziona Invia come intestazione di autenticazione di base .

  2. Seleziona Recupera nuovo token di accesso .

Impostazione dell'ambiente

Non dimenticare di impostare gli stessi valori in Ambiente .

  1. Seleziona l'icona a forma di occhio nell'angolo in alto a destra, quindi scegli Aggiungi per Ambiente.

  2. Inserisci il nome dell'ambiente.

  3. In Url di base, Chiave API e Chiave privata API, immetti gli stessi valori specificati nel passaggio 4 della sezione Impostazione dell'autorizzazione.

  4. Inserisci l'URL per l'ambiente. Puoi trovarlo in Impostazioni di sistema di Alteryx come Indirizzo base . Consulta il passaggio 4 della sezione Impostazione dell'autorizzazione.

  5. Seleziona Salva .

Invio delle richieste

Puoi testare l'API Server in Postman: autorizzare le richieste, inviarle o esplorare diversi tipi di codice delle richieste.

Esempio

Supponi di volervi recuperare un elenco di risorse possedute da un utente.

  1. Innanzitutto, devi conoscere l'ID dell'utente in questione.

    1. Accedi a Raccolte , quindi seleziona API Alteryx Server V3 .

    2. Seleziona Utenti , quindi scegli RECUPERA ricerca record utente .

    3. Nella scheda Parametri , puoi utilizzare i parametri per eseguire la ricerca in tutti i record utente.

    4. Per inviare la richiesta, seleziona Invia . Riceverai i risultati in base ai parametri specificati.

    5. Nei risultati, copia l'ID di un utente per il quale desideri recuperare un elenco di risorse.

  2. Apri una nuova richiesta in un'altra scheda. Accedi a Utenti , quindi seleziona {id} .

  3. Seleziona RECUPERA un elenco completo delle risorse possedute da un utente . Immetti l'ID utente della richiesta precedente per recuperare l'elenco delle risorse relative all'utente.

EF76F0DE8E6C3302DC8217A5E26730F2.png

Nota

Quando invii una richiesta tramite Postman, non dimenticare di autorizzarla. Puoi autorizzare la richiesta in due modi:

  • In Tipo , seleziona Oauth2 e scegli uno dei token disponibili.

  • In Tipo , seleziona Eredita autorizzazione da elemento padre . Viene utilizzata l'autorizzazione da te configurata per l'intera raccolta.

In questa sezione: