Strumento API Server
Utilizza lo strumento API Server per interagire con l'API Server (v1, v2 e v3) senza dover scrivere un flusso di lavoro complesso. Per ulteriori informazioni su accesso, autenticazione, endpoint, parametri e versioni delle API Server, accedi alla pagina Panoramica delle API Server.
Suggerimento
Questo strumento non viene installato automaticamente con Alteryx Designer. Per utilizzare questo strumento, scaricalo da Alteryx Marketplace.
Lo strumento API Server è compatibile con Designer e Server versione 2021.4 e successive. Tieni presente che alcune funzionalità dello strumento possono essere limitate in base alla versione del server in uso.
Compatibile sia con Alteryx Multi-threaded Processing (AMP) che con engine originale.
Lo strumento API Server non è attualmente supportato con la modalità solo DCM di Data Connection Manager.
Lo strumento Server API richiede che sul computer siano installati questi pacchetti:
oauthlibrequests_oauthlib
Se non hai questi pacchetti installati…
Aggiungi lo strumento Server API all'area di disegno del flusso di lavoro e avvia il flusso di lavoro. Lo strumento genera un errore per avvisare l'utente di eventuali pacchetti mancanti.
Passa alla finestra Risultati del flusso di lavoro e seleziona la scheda Tutto (o File per restringere l'elenco degli elementi).
Individua e seleziona il messaggio "Esegui questo flusso di lavoro collegato come Amministratore per installare i pacchetti mancanti". Si apre un nuovo flusso di lavoro con uno strumento Phyton preconfigurato per installare i pacchetti necessari. Avvia il flusso di lavoro per eseguire l'installazione. Tieni presente che è necessario avviare questo flusso di lavoro di installazione come Amministratore.
In alternativa, puoi replicare quanto sopra e installare i pacchetti tramite lo strumento Phyton. Per informazioni su come installare i pacchetti, passa a Installazione aggiuntiva del pacchetto.
Lo strumento API Server ha 6 ancoraggi:
Ancoraggi di input (entrambi opzionali):
Un ancoraggio di input (autorizzazione): se scegli di utilizzare i valori dai campi nella configurazione dello strumento, utilizza questo ancoraggio per fornire le informazioni di autorizzazione. Seleziona il campo che contiene l'URL di base dell'API e un altro campo che contiene le informazioni di autorizzazione (in genere questo è il campo Autorizzazione dall'output A di uno strumento API Server a monte). Tieni presente che le informazioni di autorizzazione sono una combinazione del prefisso Bearer e di access_token generato da oAuth2.0 quando esegui l'autenticazione iniziale. Per ulteriori informazioni, consulta Configurazione e autorizzazione dell'API Server.
Ancoraggio di input D (dati): se scegli di utilizzare i valori dei campi nella configurazione dello strumento, utilizza questo ancoraggio per fornire i parametri per l'endpoint. Tieni presente che alcuni endpoint hanno parametri obbligatori.
Ancoraggi di output:
Ancoraggio A (authToken): questo ancoraggio emette le tue informazioni di autenticazione in modo che siano prontamente disponibili se vuoi effettuare più chiamate. Collega questo ancoraggio di output all'ancoraggio di input A di un altro strumento API Server per riautenticare senza problemi un'altra chiamata API a valle.
Ancoraggio di output S (successo): questo ancoraggio genera qualsiasi chiamata API con un codice di risposta di 200. Analizziamo le risposte API di un livello in basso* e produciamo i campi qui. Se non è possibile analizzare una risposta, il campo di output Estratto contiene un messaggio con il motivo e forniamo i dati raw (non elaborati) nei campi di output DownloadData e BinaryData.
Ancoraggio di output F (non riuscito): questo ancoraggio produce qualsiasi chiamata API che non riceve un codice di risposta di 200.
Ancoraggio di output L (log): questo ancoraggio produce le informazioni di log risultanti dalla chiamata API.
La risposta è semplificata ai fini di questo esempio. L'esempio JSON non elaborato visualizza una tipica risposta JSON, seguita da un esempio della stessa risposta tramite lo strumento API Server.
[
{
"id": "12345",
"dateCreated": "2023-05-02T16:50:05.829Z",
"runCount": 0,
"versions": [
{
"versionId": "67890",
"versionNumber": 1,
"dateCreated": "2023-05-02T16:50:05.829Z",
"details": {
"isAmp": false,
"fileName": "test.yxmd"
}
}
]
},
{
"id": "54321",
"dateCreated": "2023-05-03T10:50:48.681Z",
"runCount": 0,
"versions": [
{
"versionId": "09876",
"versionNumber": 1,
"dateCreated": "2023-05-03T10:50:48.681Z",
"details": {
"isAmp": false,
"fileName": "test2.yxmd"
}
}
]
}
]
La stessa risposta viene formattata come segue tramite lo strumento API Server. Tieni presente che l'elemento versioni viene consolidato in una colonna/campo nella risposta dello strumento API Server.
id | dateCreated | runCount | versions |
|---|---|---|---|
12345 | 2023-05-02T16:50:05.829Z | 0 | [{'versionId': '67890', 'versionNumber': 1, 'dateCreated': '2023-05-02T16:50:05.829Z', 'details': {'isAmp': False, 'fileName': 'test.yxmd'}}] |
54321 | 2023-05-03T10:50:48.681Z | 0 | [{'versionId': '09876', 'versionNumber': 1, 'dateCreated': '2023-05-03T10:50:48.681Z', 'details': {'isAmp': False, 'fileName': 'test2.yxmd'}}] |
Utilizza la finestra di configurazione dello strumento per configurare i campi necessari per eseguire la chiamata API.
Utilizza la sezione Autenticazione per fornire le informazioni di autenticazione richieste. Per ulteriori informazioni, accedi a Chiavi API e accesso API, nonché a Configurazione e autorizzazione dell'API Server .
Usa i valori dei campi: opzione disattivata per impostazione predefinita. Attiva questa opzione per specificare un campo in entrata che memorizza le informazioni relative all'URL di base e al token di autorizzazione (Chiave di accesso API e Chiave privata di accesso API). Seleziona i campi tramite i menu a discesa Seleziona il campo URL di base) e Seleziona campo Autorizzazione). Se utilizzi questa opzione, viene utilizzato solo il primo record fornito come URL di base e token di autenticazione.
Inoltre puoi fornire le informazioni di autenticazione direttamente tramite la finestra Configurazione dello strumento. Tieni presente che questi campi sono nascosti se attivi l'opzione Usa valori dei campi.
URL di base: fornisci l'URL di base per l'API Server. Puoi configurarlo tramite Configurazione interfaccia utente di Server.
Chiave API: immetti la chiave API.
Chiave privata API: immetti la chiave privata API.
Utilizza la sezione Configurazione dell'API per selezionare il metodo, scegliere un endpoint e fornire i parametri per la chiamata API.
Scegli metodo: utilizza questo menu a discesa per selezionare il metodo API. Scegli tra…
GET: il metodo GET consente di leggere o visualizzare una risorsa. Ad esempio, il metodo GET su un endpoint utenti consente di leggere o visualizzare un elenco di utenti.
POST: il metodo POST consente di creare una risorsa. Ad esempio, il metodo POST su un endpoint utenti consente di creare un nuovo utente.
PUT: il metodo PUT consente di aggiornare una risorsa. In particolare, il metodo PUT sostituisce la risorsa esistente. Ad esempio, il metodo PUT su un endpoint utenti consente di aggiornare sostituendo i dettagli utente esistenti con le informazioni utente fornite.
DELETE: il metodo DELETE consente di eliminare una risorsa. Ad esempio, il metodo DELETE su un endpoint utenti consente di eliminare un utente esistente. Quando selezioni il metodo DELETE, viene visualizzata l'opzione Conferma metodo DELETE. Devi attivare questa opzione per eseguire correttamente un'eliminazione.
Endpoint: utilizza questo menu a discesa per selezionare l'endpoint. Le opzioni variano a seconda del metodo selezionato. Per ulteriori informazioni sugli endpoint e i parametri dell'API Server, accedi a Endpoint e parametri API, Accesso all'API Server V3 e Oggetti dell'API Server V3.
Utilizza i campi in entrata per i parametri*: opzione disattivata per impostazione predefinita. Attiva questa opzione per specificare i campi in entrata da utilizzare come parametri. Quindi, utilizza i menu a discesa disponibili per specificare il campo che contiene le informazioni sui parametri.
Immetti i valori dei parametri*: se scegli di non utilizzare i campi in entrata per i tuoi parametri, puoi immettere i parametri direttamente tramite i campi forniti.
Parametri endpoint
Tieni presente che i parametri disponibili dipendono dall'endpoint. Inoltre, alcuni endpoint hanno parametri richiesti, mentre altri no. Per ulteriori informazioni sugli endpoint e i parametri dell'API Server, consulta Endpoint e parametri API, Accesso all'API Server V3 e Oggetti dell'API Server V3.
Payload: se scegli di inserire il payload manualmente, puoi inserirlo qui direttamente nel formato JSON. In alternativa, utilizza il pulsante Utilizza i campi in entrata per i parametri sopra indicato per specificare il campo in entrata che contiene il payload.
Esempio di schema: se applicabile, l'esempio di schema viene compilato con una struttura corretta per il payload API. Puoi selezionare il pulsante Usa lo schema in Payload per copiare il testo generico nella scheda del payload e modificarlo.