This article assumes previous experience with APIs.
Consulta gli articoli su Tabelle, Operatori e Macchine per scoprire come configurare la chiave API.
Utilizza i connettori Tulip per testare l’API di Tulip
Prior to r383, Service Accounts were called "API Tokens".
Leggi le istruzioni su come configurare un connettore e impostarlo utilizzando l’account di servizio API che hai configurato (consulta questo articolo su come configurare un account di servizio).
Una volta configurato il connettore, fare clic su “Crea funzione”. In questo esempio, illustreremo come recuperare i record da una tabella.
Per prima cosa, devi formulare una richiesta utilizzando i metodi GET, POST, PUT, HEAD, PATCH o DELETE, quindi specificare l’URL esatto a cui desideri inviare la richiesta (leggi qui per ulteriori informazioni sulle funzionalità della nostra API e ) .
If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.
https://(nome della tua istanza qui).tulip.co/api/v3/w/(spazio di lavoro)/tables/(ID tabella)/records
Assicurati di aggiungere le tue credenziali di autenticazione (provenienti dall’account di servizio stesso), le intestazioni della richiesta (se necessarie) e i parametri di query (sia nell’URL stesso che nei parametri di query — leggi come impostare i parametri di query per ulteriori informazioni).
Inoltre, è possibile specificare eventuali input o output che la funzione del connettore potrebbe dover restituire a un’app o a un’automazione.
Utilizzo di Postman per testare l’API di Tulip
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.
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 (Body), 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, assicurati che la chiave e il segreto siano corretti. Per ulteriori informazioni sui codici di risposta specifici, consulta la sezione "Documentazione API" nella pagina dell'API di Tulip.
Utilizzo della documentazione API per testare l’API di Tulip
Nelle impostazioni del tuo Workspace o del tuo account, vai su API di Tulip. Da lì, clicca su "Scopri di più" accanto all’opzione Crea account di servizio.
Verrai reindirizzato a una pagina che ti consentirà di testare l’API con la chiave generata. La pagina fornisce inoltre la documentazione e offre esempi di corpi di richiesta per vari utilizzi.
Questa pagina contiene anche l’URL del server necessario per configurare le richieste API da sistemi esterni. Per familiarizzare con l’API, clicca sul pulsante “Autorizza”.
Questo pulsante fornirà ulteriori informazioni sulla configurazione dell’API a scopo di test. Nei campi, inserisci quanto segue:
- Nome utente: Chiave API
- Password: Segreto
Fai clic su "Autorizza" e potrai iniziare a testare alcune richieste HTTP comuni per le tabelle.
Ciascuna delle opzioni presenti in questa pagina può essere espansa e testata. Ogni richiesta fornisce informazioni utili sulle risposte corrispondenti.
All’interno di questa pagina sono presenti anche informazioni sugli schemi relativi ad alcuni componenti di Tulip. Ad esempio, per creare un record di tabella, è utile conoscere il formato JSON appropriato per ciascuna colonna. Di seguito è riportato un esempio di schema per le colonne:
