Panoramica sulle API

Importante

Se non hai esperienza con le API, consulta la pagina di assistenza Guida introduttiva alle API .

Importante

A partire dalla versione 2022.1, abbiamo rimosso gli endpoint pubblici API OAuth1 legacy perché richiedono l'hash SHA1 non conforme a FIPS. La rimozione include gli endpoint WCF (Windows Communication Framework) legacy, lo Swagger per tali endpoint e il middleware OAuth1. Per sostituire gli endpoint OAuth1, è possibile utilizzare le versioni OAuth2 delle API legacy rilasciate nella versione 21.4 e conformi a FIPS. Le API OAuth2 offrono le stesse funzionalità delle API OAuth1.

Gli endpoint Subscription, V1 e V2 continueranno a essere supportati in OAuth2.

Per ulteriori informazioni sulla conversione e sul suo impatto, visita la pagina della guida Istruzioni da OAuth1 a OAuth2 o Istruzioni per la conversione .

L'API Server è composta da 6 API:

API di iscrizione : endpoint che consentono agli utenti di interagire con iscrizioni, flussi di lavoro e pianificazioni (processi).
API V2 utente : endpoint che consentono agli utenti di interagire con credenziali, file di input e programmazioni (processi).
API V1 di amministrazione : endpoint che consentono agli amministratori di recuperare le risorse dall'interfaccia di amministrazione.
API V2 di amministrazione : versione 2 degli endpoint che consente agli amministratori di recuperare le risorse dall'interfaccia di amministrazione.
API V3 di amministrazione : versione 3 degli endpoint. Questa versione utilizza Oauth 2.
API V3 utente : versione 3 degli endpoint per gli utenti. Questa versione utilizza Oauth 2.

Nota

Oltre ad aggiungere nuove funzionalità con gli endpoint dell'API V3 , abbiamo reso disponibili anche gli endpoint V1, di iscrizione e V2 per l'utilizzo con Oauth 2. Gli stessi endpoint che hai utilizzato in passato sono ora disponibili per Oauth 2 a un nuovo indirizzo base.

L'indirizzo API Web può essere impostato solo per V1, V2 e V3 con Oauth 2. Per la documentazione relativa all'API V1 e V2 con Oauth 1, l'indirizzo è http://{ServerHostname}/gallery/api-docs/ .

The Web API address can be set up in System Settings.

Accesso ai documenti di riferimento dell'API Server

La documentazione di riferimento completa per tutti gli endpoint dell'API Server è disponibile in Swagger.

La documentazione di riferimento dell'API Server è accessibile in due posizioni nell'interfaccia utente di Server.

Seleziona l'icona con il punto interrogativo nella barra degli strumenti superiore e scegli Documentazione API .
Seleziona il tuo nome utente e scegli Profilo personale > Chiavi . Accanto alle chiavi API sono disponibili i collegamenti alla documentazione API.

Puoi anche accedere alla documentazione di riferimento per l'API Server tramite il seguente URL: http(s)://serverhostname.domain/webapi/swagger Serverhostname è l'URL dell'istanza di Server.

Autenticazione per i documenti di riferimento dell'API Server

I documenti relativi all'API Server sono interattivi e consentono di compilare i parametri e visualizzare le risposte. Per sfruttare questa interattività, è necessario eseguire l'autenticazione attenendoti alla seguente procedura:

Nell'interfaccia utente di Server, seleziona il tuo nome utente e scegli Profilo personale > Chiavi . Copia le chiavi per l'API a cui desideri autenticarti e incollale nei campi Chiave API e Chiave segreta condivisa . Le chiavi vengono visualizzate come Salvate .
Seleziona la chiamata che desideri eseguire, compila i parametri e scegli Prova .

Chiavi API e accesso all'API

Gli amministratori (di Server) devono autorizzare gli utenti ad accedere all'API. Per ulteriori informazioni, consulta Accesso degli utenti all'API Server . Una volta ottenuto l'accesso all'API, gli utenti possono trovare le chiavi API nella scheda Chiavi della pagina Profilo personale . Per accedere alle chiavi API, seleziona il tuo nome utente e scegli Profilo personale > Chiavi .

Gli utenti con ruolo di amministratore possono utilizzare le chiavi di accesso all'API per accedere a tutte le API, inclusa l'API di iscrizione, l'API V2 utente, l'API V1 di amministrazione, l'API V2 di amministrazione e l'API V3.

Tutti gli utenti che non hanno il ruolo di amministratore possono utilizzare le chiavi di accesso all'API per accedere all'API di iscrizione e all'API V2 utente.

Autenticazione

Per ulteriori informazioni, consulta l'articolo Configurazione e autorizzazione dell'API Server .

Costruzione degli endpoint API

Per costruire un endpoint API, utilizza questo schema: <hostname>/webapi/ .

Endpoint e parametri API

In questa sezione troverai ulteriori informazioni sui seguenti endpoint:

Endpoint del registro di controllo

Server tiene traccia delle modifiche apportate alle seguenti entità di sistema:

AppInfo (flusso di lavoro)
Raccolta
Credenziale
Iscrizione
Utente
UserGroup

Recupero degli eventi registrati tramite l'API Server

Eventuali aggiornamenti a queste entità attivano la creazione di un record AuditEvent. È possibile restituire questi record tramite un endpoint API di un amministratore pubblico.

Endpoint

L'endpoint per AuditEvents è GET /admin/v1/auditlog/

Parametri di query richiesti

entity: (string) l'entità del log di controllo per la quale si desidera eseguire una query.
page: (int) la pagina che si desidera restituire.
pageSize: (int) il numero di record da restituire in ogni pagina.

La risposta sarà una serie di record Evento di controllo:

[
  {
    "id": "",
    "entity": "",
    "entityId": "",
    "userId": "",
    "timestamp": "Date",
    "event": "",
    "oldValues": "",
    "newValues": ""
  }
]

Le proprietà restituite sono definite di seguito:

id: l'ID dell'evento di controllo.
entity: il nome dell'entità.
entityId: l'ID dell'entità.
userId: l'ID dell'utente che ha modificato l'entità.
timestamp: la data e l'ora di creazione del record Evento di controllo.
event: l'evento che si è verificato (inserimento, aggiornamento, eliminazione).
oldValues: i valori delle proprietà aggiornate prima dell'aggiornamento.
newValues: i valori delle proprietà aggiornate dopo l'aggiornamento.

Endpoint Inputfiles

Per eseguire i flussi di lavoro che utilizzano lo strumento Sfoglia file tramite l'API, utilizza l'endpoint /user/v2/inputfiles per caricare il file. Strumento Sfoglia file

Inizia inoltrando una richiesta POST multipart/form-data all'endpoint /user/v2/inputfiles per pubblicare un file temporaneo. Il nome della sezione form-data richiesta è inputFile.
```
curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \
--form 'inputFile=@/file/path/filename.csv' 
```

Quindi, invia una richiesta POST all'endpoint /user/v2/workflows/{appId}/jobs/.

Successivamente, includi il nome dello strumento Sfoglia file nell'oggetto della domanda. In caso di dubbi sul nome dello strumento Sfoglia file, utilizza l'endpoint /v1/workflows/{appId}/questions per scoprirlo.
Il valore è l'ID di riferimento restituito nella risposta dalla chiamata al file di input.

curl --location --request POST 'http:{yourhostname}/api/user/v2/workflows/{appId}/jobs' \
--header 'Content-Type: text/plain' \
--header 'Authorization: OAuth oauth_consumer_key="{consumer key}",
                         oauth_signature_method="HMAC-SHA1",
                         oauth_timestamp="{timestamp}",
                         oauth_nonce="{nonce}",
                         oauth_signature="{signature}"' \
--data-raw '{
    "questions": [
        {
            "name": "File Browse",
            "value": "{reference ID}"
        }
    ]
    "priority": "Low"
}'

Endpoint migratable

Utilizza l'endpoint migratable per migrare i flussi di lavoro tra gli ambienti di Server. Puoi utilizzare questo endpoint per gestire le distribuzioni dei flusso di lavoro durante le fasi di sviluppo e test.

Per iniziare, è necessario abilitare i flussi di lavoro per la migrazione . Dopo aver contrassegnato i flussi di lavoro per la migrazione, attieniti alla procedura di seguito per pubblicarli dall'ambiente di origine nell'iscrizione appropriata (studio) dell'ambiente di destinazione.

Passaggio 1. Ottieni un elenco dei flussi di lavoro pronti per la migrazione

Successivamente, ottieni un elenco di flussi di lavoro pronti per la migrazione utilizzando il seguente endpoint:

Ambiente: origine
Metodo: GET
Endpoint: api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

Includi un elenco separato da virgole di subscriptionIds come parametro di query. Gli ID iscrizione identificano uno studio specifico.

Il risultato è una serie di flussi di lavoro contrassegnati come pronti per la migrazione nell'iscrizione specificata (studio). Se non fornisci subscriptionIds, vengono forniti tutti i flussi di lavoro contrassegnati come pronti per la migrazione. Il risultato include 3 proprietà: appId, revisionid attualmente pubblicato e subscriptionID di appartenenza del flusso di lavoro.

Passaggio 2. Scarica i flussi di lavoro dall'ambiente di origine

Il seguente endpoint scarica il flusso di lavoro come file YXZP.

Ambiente: origine
Metodo: GET
Endpoint: api/admin/v1/{appID}/package/

Includi un appID come parametro di percorso. Il risultato sarà un download dell'intero flusso di lavoro come pacchetto.

Passaggio 3. Pubblica i flussi di lavoro nell'ambiente di destinazione

Il seguente endpoint pubblica il flusso di lavoro scaricato nell'ambiente di destinazione.

Ambiente: destinazione
Metodo: POST
Endpoint: api/admin/v1/workflows/

Parametri
Parametro	Descrizione	Tipo	Obbligatorio
`file`	Il nome file del nuovo flusso di lavoro.	Stringa	True
`name`	Il nome del nuovo flusso di lavoro.	Stringa	True
`owner`	Il proprietario del flusso di lavoro migrato. L'indirizzo e-mail deve esistere nell'ambiente di destinazione.	Stringa	True
`validate`	Contrassegno per convalidare il flusso di lavoro durante la migrazione all'ambiente di destinazione.	Booleano	True
`isPublic`	Contrassegno per impostare il flusso di lavoro come pubblico e visualizzarlo in "Gallery della mia azienda" nell'ambiente di destinazione.	Booleano	True
`sourceId`	L'appId dell'ambiente di origine del flusso di lavoro da migrare. Se è presente un flusso di lavoro con lo stesso sourceId, questo sostituisce il flusso di lavoro nell'ambiente di destinazione. In caso contrario, viene generato un nuovo flusso di lavoro. (Invia una stringa vuota se non desideri specificare un appID.)	Stringa	True
`workerTag`	Aggiungi un tag worker al flusso di lavoro se desideri che questo sia eseguito da un worker specifico. (Invia una stringa vuota se non desideri specificare un worker.)	Stringa	True
`canDownload`	Contrassegno per impostare il flusso di lavoro come disponibile per il download da parte di altri utenti nell'ambiente di destinazione.	Booleano	True

Passaggio 4 (facoltativo). Ripristina i flussi di lavoro delle impostazioni di migrazione nell'ambiente di origine

Puoi utilizzare l'endpoint migratable per ripristinare l'impostazione Questo flusso di lavoro è pronto per la migrazione di un flusso di lavoro su No nell'ambiente di origine dopo la migrazione del flusso di lavoro nell'ambiente di destinazione.

Ambiente: origine
Metodo: PUT
Endpoint: api/admin/v1/workflows/migratable/{appID}/

Per ulteriori informazioni su tutti gli endpoint dell'API Server, consulta API Server .

Per ulteriori informazioni sugli endpoint e i parametri dell'API Server V3, consulta la pagina di assistenza API Alteryx Server V3 .

API Server

Nella tabella seguente è riportato l'elenco di tutte le API Server rilasciate. Se un'API è disponibile per gli utenti, lo è anche per gli amministratori.

	Sezione	Endpoint API	Versione	Build di rilascio per amministratori	Build di rilascio per utenti	Descrizione
1	Dati di verifica	GET /admin/v1/auditlog	v1	9.1		Recupera le voci del registro di controllo per un determinato tipo di entità
2	Raccolte	GET /v3/collections	v3	2021.4		Recupera tutti i record di raccolta accessibili
3	Raccolte	POST /v3/collections	v3	2021.4		Crea una nuova raccolta.
4	Raccolte	DELETE /v3/collections/{collectionId}	v3	2021.4		Elimina una raccolta
5	Raccolte	GET /v3/collections/{collectionId}	v3	2021.4		Recupera un record di raccolta
6	Raccolte	PUT /v3/collections/{collectionId}	v3	2021.4		Aggiorna una raccolta esistente per modificare il nome o il proprietario
7	Raccolte	PUT /v3/collections/{collectionId}/users//permissions Permessi	v3	2021.4		Aggiorna le autorizzazioni degli utenti di una raccolta
8	Raccolte	PUT /v3/collections/{collectionId}/userGroups//permissions Permessi	v3	2021.4		Aggiorna le autorizzazioni dei gruppi di utenti di una raccolta
9	Raccolte	POST /v3/collections/{collectionId}/users	v3	2021.4		Aggiungi un utente a una raccolta
10	Raccolte	POST /v3/collections/{collectionId}/insights	v3	2021.4		Aggiungi un insight a una raccolta
11	Raccolte	POST /v3/collections/{collectionId}/schedules	v3	2021.4		Aggiungi una pianificazione a una raccolta
12	Raccolte	POST /v3/collections/{collectionId}/workflows	v3	2021.4		Aggiungi un flusso di lavoro a una raccolta
13	Raccolte	POST /v3/collections/{collectionId}/userGroups	v3	2021.4		Aggiungi un gruppo di utenti a una raccolta
14	Raccolte	DELETE /v3/collections/{collectionId}/users/{userId}	v3	2021.4		Rimuovi un utente da una raccolta
15	Raccolte	DELETE /v3/collections/{collectionId}/workflows/{appId}	v3	2021.4		Rimuovi un flusso di lavoro da una raccolta
16	Raccolte	DELETE /v3/collections/{collectionId}/insights/{insightId}	v3	2021.4		Rimuovi un insight da una raccolta
17	Raccolte	DELETE /v3/collections/{collectionId} pianificazioni	v3	2021.4		Rimuove una pianificazione da una raccolta.
18	Raccolte	DELETE /v3/collections/{collectionId} userGroups	v3	2021.4		Rimuovi un gruppo di utenti da una raccolta
19	Raccolte	GET /admin/v1/collections	v1	9.1		Trova le raccolte in Server
20	Credenziali	GET /v3/credentials/{credentialId}	v3	2021.4	2022.3	Recupera un record delle credenziali
21	Credenziali	GET /v3/credentials	v3	2021.4	2022.3	Recupera i record delle credenziali
22	Credenziali	DELETE /v3/credentials/{credentialId}	v3	2021.4		Elimina una credenziale
23	Credenziali	POST /v3/credentials/{credentialId}/users	v3	2021.4		Condividi una credenziale con un utente
24	Credenziali	POST /v3/credentials/{credentialId}/userGroups	v3	2021.4		Condividi una credenziale con un gruppo di utenti
25	Credenziali	DELETE /v3/credentials/{credentialId}/users/{userId}	v3	2021.4		Rimuove un utente da una credenziale
26	Credenziali	DELETE /v3/credentials/{credentialId} userGroups	v3	2021.4		Rimuove un gruppo di utenti da una credenziale
27	Credenziali	GET /user/v2/credentials	v2	11.3		Trova le credenziali condivise direttamente con gli utenti o tramite un'iscrizione
28	DCMEConnections	GET /v3/DCMEConnections/{connectionId}	v3	2022.1		Recupera una connessione DCM.E.
29	Insights	GET /admin/v2/insights	v2	11.3		Trova gli insight in Server
30	Insights	GET /admin/v1/insights	v1	9.1		Trova gli insight in Server
31	Processi	GET /v3/jobs/	v3	2022.3	2022.3	Recupera il processo e lo stato corrente
32	Processi	POST /user/v2/workflows/{appId}/jobs Nota Se il flusso di lavoro è stato pubblicato con una credenziale, è necessario applicare esplicitamente una credenziale condivisa nella chiamata API.	v2	11.3	11.3	Crea un nuovo processo e lo aggiunge alla coda di esecuzione del processo
33	Processi	GET /v1/jobs/{id}/output/{outputId}	v1	9.1	9.1	Ottieni un output per un determinato processo
34	Processi	GET /v1/jobs/{id}	v1	9.1	9.1	Recupera il processo e lo stato corrente
35	Processi	GET /v1/workflows/{appId}/jobs	v1	9.1	9.1	Restituisce i processi per l'app Alteryx Analytics specificata
36	Processi	POST /v1/workflows/{appId}/jobs Nota Utilizza POST /user/v2/workflows/{appId}/jobs se il flusso di lavoro richiede una credenziale per l'esecuzione.	v1	9.1	9.1	Mette in coda l'esecuzione di un processo per il flusso di lavoro specificato con le risposte fornite
37	Processi	GET /admin/v1/workflows/jobs	v1	9.1		Restituisce l'ultimo processo eseguito e lo stato corrente per i flussi di lavoro
38	Programmazioni	DELETE /v3/schedules/{id}	v3	2021.4		Elimina una pianificazione
39	Programmazioni	GET /v3/schedules/{id}	v3	2021.4		Ottieni le informazioni su una pianificazione specifica
40	Programmazioni	PUT /v3/schedules/{id}	v3	2021.4		Aggiorna una pianificazione esistente
41	Programmazioni	GET /v3/schedules	v3	2021.4		Ottieni tutte le pianificazioni
42	Programmazioni	POST /v3/schedules	v3	2021.4		Crea una nuova pianificazione
43	Programmazioni	GET /admin/v2/schedule/forecast	v2	11.3		Prevede tutti i processi eseguiti futuri per il periodo di tempo specificato
44	Programmazioni	GET /admin/v1/schedules	v1	9.1		Trova le pianificazioni in Server
45	Connessioni Server	GET /v3/serverDataConnections	v3	2021.4		Recupera tutti i record di connessione dati del Server
46	Connessioni Server	DELETE /v3/serverDataConnections/{dataConnectionId}	v3	2021.4		Elimina una connessione dati del server
47	Connessioni Server	GET /v3/serverDataConnections/ {dataConnectionId}	v3	2021.4		Recupera un record di connessione dati del Server
48	Connessioni Server	PUT /v3/serverDataConnections/ {dataConnectionId}	v3	2021.4		Aggiorna una connessione dati del Server esistente per modificare il nome della connessione
49	Connessioni Server	POST /v3/serverDataConnections//users users	v3	2021.4		Aggiungi un utente a una connessione dati del Server esistente
50	Connessioni Server	POST /v3/serverDataConnections//users userGroups	v3	2021.4		Aggiungi un gruppo di utenti a una connessione dati del Server esistente
51	Connessioni Server	DELETE /v3/serverDataConnections/ gli utenti.	v3	2021.4		Rimuovi un utente da una connessione dati del Server esistente
52	Connessioni Server	DELETE /v3/serverDataConnections/ userGroups	v3	2021.4		Rimuove un gruppo di utenti da una connessione dati del Server esistente
53	Connessioni Server	GET /admin/v1/serverdataconnections	v1	9.1		Restituisce le connessioni dati create in una galleria privata
54	Subscriptions	GET /admin/v2/subscriptions	v2	11.3		Trova le iscrizioni in Server
55	Subscriptions	GET /admin/v1/subscriptions	v1	9.1		Trova le iscrizioni in Server
56	Alias di sistema	GET /admin/v1/systemdataconnections	v1	9.1		Restituisce le connessioni dati del sistema create sul server in cui è installato Alteryx Server
57	Gruppi utenti	GET /v3/usergroups	v3	2021.4		Ottieni tutti i gruppi utenti dei clienti
58	Gruppi utenti	POST /v3/usergroups	v3	2021.4		Creare un nuovo gruppo utenti personalizzato
59	Gruppi utenti	DELETE /v3/usergroups/{id}	v3	2021.4		Elimina un gruppo di utenti personalizzato dal sistema
60	Gruppi utenti	GET /v3/usergroups/{id}	v3	2021.4		Recuperare un gruppo utenti personalizzato
61	Gruppi utenti	PUT /v3/usergroups/{id}	v3	2021.4		Aggiorna il nome e il ruolo di un gruppo di utenti
62	Gruppi utenti	POST /v3/usergroups/{id}/users	v3	2021.4		Aggiungi uno o più utenti a un gruppo di utenti
63	Gruppi utenti	DELETE /v3/usergroups/{userGroupId}/users/{userId}	v3	2021.4		Aggiungi un gruppo Active Directory come membro di un gruppo personalizzato di Server.
64	Utenti	DELETE /v3/users/{id}	v3	2021.4		Elimina un utente dal sistema
65	Utenti	GET /v3/users/{id}	v3	2021.4		Recupera un record utente
66	Utenti	GET /v3/users/{id}/assets	v3	2021.4		Recupera un elenco completo delle risorse di proprietà di un utente.
67	Utenti	GET /v3/users	v3	2021.4		Cerca i record utente
68	Utenti	POST /v3/users	v3	2021.4		Crea un nuovo record utente
69	Utenti	POST /v3/users/{id}/deactivate	v3	2021.4		Disattiva un utente nel sistema
70	Utenti	POST /v3/users/{id}/passwordReset	v3	2021.4		Invia un'e-mail per la reimpostazione della password all'utente specificato.
71	Utenti	PUT /v3/users/{id}	v3	2021.4		Aggiorna un utente esistente
72	Utenti	GET /admin/v2/users	v2	11.3		Trova gli utenti in Server
73	Utenti	GET /admin/v1/users	v1	9.1		Trova gli utenti in Server
74	Flussi di lavoro	GET /v3/Workflows/{workflowId}	v3	2021.4		Recupera un record del flusso di lavoro
75	Flussi di lavoro	GET /v3/workflows/{workflowId}/package	v3	2022.3	2022.3	Scarica un pacchetto del flusso di lavoro
76	Flussi di lavoro	GET /v3/workflows/{workflowId}/questions	v3	2022.3	2022.3	Recupera le informazioni sulle domande per un flusso di lavoro
77	Flussi di lavoro	GET /v3/workflows/{workflowId}/jobs	v3	2022.3	2022.3	Recupera un elenco di processi per un flusso di lavoro esistente.
78	Flussi di lavoro	GET /v3/workflows	v3	2021.4	2022.3	Recupera tutti i record del flusso di lavoro
79	Flussi di lavoro	POST /v3/workflows	v3	2021.4	2022.3	Carica un nuovo flusso di lavoro
80	Flussi di lavoro	DELETE /v3/workflows/{workflowId}	v3	2021.4		Elimina un flusso di lavoro specifico
81	Flussi di lavoro	PUT /v3/workflows/{workflowId}	v3	2021.4		Aggiorna un flusso di lavoro esistente
82	Flussi di lavoro	POST /user/v2/inputfiles	v2	2020.3	2020.3	Pubblicato un file temporaneo da utilizzare in una successiva esecuzione del flusso di lavoro
83	Flussi di lavoro	GET /admin/v2/workflows/all	v2	11.3		Restituisci tutti i flussi di lavoro, facoltativamente filtrati per data
84	Flussi di lavoro	GET /v1/workflows/{appId}/package	v1	9.1	9.1	Restituisce l'app richiesta
85	Flussi di lavoro	GET /v1/workflows/{appId}/questions	v1	9.1	9.1	Ottieni le domande per l'app Alteryx Analytics specificata
86	Flussi di lavoro	GET /v1/workflows/subscription	v1	9.1	9.1	Trova i flussi di lavoro in un'iscrizione
87	Flussi di lavoro	GET /admin/v1/{appId}/package	v1	9.1		Restituisce l'app richiesta
88	Flussi di lavoro	GET /admin/v1/workflows/migratable	v1	9.1		Trova i flussi di lavoro in Server contrassegnati come pronti per la migrazione
89	Flussi di lavoro	GET /admin/v1/workflows/all	v1	9.1		Restituisci tutti i flussi di lavoro, facoltativamente filtrati per data
90	Flussi di lavoro	GET /admin/v1/workflows	v1	9.1		Trova i flussi di lavoro in Server
91	Flussi di lavoro	POST /admin/v1/workflows	v1	9.1		Pubblica un file YXZP nel sistema
92	Flussi di lavoro	PUT /admin/v1/workflows/migratable/{appId}	v1	9.1		Aggiorna il contrassegno di app pronta per la migrazione.

In questa sezione: