Guida all’API per gli operatori

Prev Next

Scopri come configurare l’API per gli operatori

Advanced Content

This article assumes previous experience with APIs.

L’aggiunta di operatori al tuo sito è necessaria per popolare gli utenti che utilizzeranno le app sviluppate in Tulip. Puoi creare operatori in due modi:* Dalla pagina Utenti, situata in Impostazioni* Utilizzando un sistema esterno tramite l’API di Tulip.

La procedura riportata di seguito illustra come utilizzare l’API di Tulip per creare operatori.

Aggiungere un token API operatore

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

Nella tua istanza di Tulip, clicca sull’icona del profilo nell’angolo in alto a destra e seleziona Impostazioni.

Configuring Your Tulip Account Settings_124925135

Seleziona API di Tulip, quindi fai clic sul pulsante Crea account di servizio in alto a destra.

Create%20API%20token1

Nel menu Creazione, assegna un nome al token API e seleziona l'ambito users:write. Fai clic su Crea.

Create API Token

Note

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.

Utilizzo dell’API Operator

Di seguito verrà illustrato come creare un operatore. In questo caso, l'esempio utilizzerà Postman per eseguire la creazione.

Per prima cosa, aggiungi il tuo endpoint API alla richiesta POST.

NOTE

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

https://(nome della tua istanza).tulip.co/api/v3/w/(workspace)/users

Quindi, nella sezione "Authorization", seleziona "Basic Auth " e inserisci la chiave API come nome utente e il segreto API come password.

Nella sezione "Headers", aggiungi l’intestazione "Auth".

Nel corpo della richiesta, imposta il formato in modo da includere l’oggetto JSON. Il formato generico per questa richiesta è il seguente.

{"role": "operator","name": "string","badge_id": "string"}

Il risultato sarà simile a questo:

Fai clic su "Invia" per eseguire la richiesta; riceverai una risposta 201 a indicare che l'operazione è andata a buon fine. Per verificare, puoi controllare l'elenco degli utenti in "Impostazioni" e confermare che l'utente sia stato creato correttamente.

Se la richiesta non è andata a buon fine, verifica che la chiave e il segreto siano corretti. Per ulteriori informazioni sui codici di risposta specifici, consulta Introduzione alle API.


Hai trovato quello che cercavi?

Puoi anche visitare community.tulip.co per pubblicare la tua domanda o vedere se altri hanno avuto un problema simile!