Come utilizzare l'API Tabella

Scopo

Impostare e utilizzare l'API di Tulip per interagire con Tulip da altri sistemi.

Nota: Articolo avanzato.

Presuppone un'esperienza precedente con le API.

:::(Info) (NOTA) Articolo avanzato: Presuppone un'esperienza precedente con le API :::

Tulip interagisce con molte API di altri sistemi tramite connettori. Uso dei connettori Un'applicazione Tulip può avviare una query HTTP o SQL.

In altri casi, si potrebbe voler consentire a un sistema esterno di interrogare dati che esistono solo all'interno di Tulip. È possibile comunicare con Tulip da sistemi esterni utilizzando l'API di Tulip. Questo articolo illustra la configurazione e il test dell'API Tulip.

L'API di Tulip è utile per integrare questi sistemi esterni con Tulip in molti modi. L'API funziona attualmente solo con le tabelle di Tulip, ad esempio aggiornando i record di una tabella con nuove informazioni, creando una tabella o ottenendo il conteggio dei record in una tabella.

Aggiungere un'API

Andare alla pagina Impostazioni del proprio account Tulip.

Nel menu Impostazioni, selezionare Token API.

Questa pagina consente di configurare i "Token API", che sono configurazioni API dotate di chiave API, segreto e intestazione di autorizzazione. Per aggiungere un token API, selezionare il pulsante Aggiungi token API in alto a destra in questa pagina. Una volta selezionato, configurare il token API come desiderato.

Assegnate un nome al token API e definite gli ambiti che potrà eseguire. In questo esempio, il token API è in grado di leggere dalle tabelle Tulip e di scrivere su di esse. I token API possono essere archiviati se non vengono utilizzati.

Facendo clic su Crea, verranno fornite le informazioni sull'API. Assicurarsi di salvare queste informazioni, perché non è possibile accedervi di nuovo!

Queste informazioni possono ora essere utilizzate per configurare una connessione all'API di Tulip.

Testare l'API

Chiudere il popup delle informazioni e spostarsi sul pulsante Documentazione API, accanto all'opzione Crea token API.

Si accede così a una pagina che consente di testare l'API con la chiave creata. Fornisce anche la documentazione e fornisce esempi di corpi di richiesta per vari usi.

Questa pagina contiene anche l'URL del server necessario per configurare le richieste API da sistemi esterni. Per familiarizzare con l'API, fare clic sul pulsante Autorizza.

Questo pulsante fornisce ulteriori informazioni sulla configurazione dell'API a scopo di test. Nei campi, inserire quanto segue:

• Nome utente: Chiave API
• Password: Segreto

Facendo clic su Autorizza, è possibile iniziare a testare alcune richieste HTTP comuni per le tabelle.

Ogni opzione di questa pagina può essere ampliata e testata. Ogni richiesta fornisce informazioni utili sulle risposte corrispondenti.

In questa pagina sono presenti anche informazioni sugli schemi di alcuni componenti di Tulip. Ad esempio, per creare un record di tabella, è utile conoscere la formattazione JSON appropriata per ogni colonna. Di seguito è riportato un esempio di schema per le colonne:

Interrogazione con i filtri

I filtri possono essere molto utili per estrarre solo i dati che interessano. La sintassi di questi filtri può essere a volte un po' complicata. Di seguito viene illustrato il modo in cui ciascuno di essi viene formato nell'esempio di una richiesta GET di record, seguito da un esempio completo.

Inomi dei campi personalizzati sono sempre preceduti da un identificatore a cinque cifre. Questi possono essere trovati più facilmente dopo una richiesta GET all per verificare il vero nome del campo.

• Es. "campo"="maytq_scrap_count"

I valoridegli argomenti sono spesso semplici. Se si tratta di un valore di testo, assicurarsi di metterlo tra virgolette.

• Es. "arg":15

Abbinare il tipo di funzione che si desidera utilizzare.

• Es. "functionType": "greaterThan".

Una richiesta completa potrebbe essere simile a questa:

https://brian.tulip.co/api/v3/tables/W2HPvyCZrjMMHTiip/records?limit=100&sortBy=\\\code(01)019&sortDir=asc&filters=[{"field": "maytq_scrap\_count", "arg":15, "functionType": "greaterThan"}]&filterAggregator=any

Filtri multipli

In alcuni casi, si possono avere più filtri da controllare nella tabella. In questo caso, è possibile aggiungere più filtri all'oggetto filters. L'aspetto potrebbe essere simile a questo:

filters=[{"campo": "maytq_scrap\_count", "arg":15, "functionType": "greaterThan"},{"campo": "maytq\_scrap\_reason", "arg": "scratch", "functionType": "equal"}]

Esempi

I seguenti esempi illustrano il processo per effettuare richieste all'API di Tulip. Questi esempi utilizzeranno Postman per effettuare le richieste a Tulip.

Ottenere i nomi e le informazioni delle tabelle

Questa richiesta Get consente al sistema esterno di recuperare gli ID e le informazioni sulle colonne di tutte le tabelle dell'istanza Tulip. Può essere utile come metodo per trovare una tabella di interesse per impostare una richiesta POST.

In Postman, impostare l'autorizzazione su Basic Auth e inserire la chiave API e il segreto.

Ora la richiesta deve andare nel posto giusto. In Tulip, trovare la richiesta che si desidera fare nella documentazione dell'API. In questo caso, la richiesta è di ottenere tutte le informazioni sulla tabella.

Per ottenere l'URL della richiesta, eseguire il pulsante Esegui e controllare le Informazioni sulla richiesta.

Questo URL di richiesta può essere utilizzato come URL del server per elaborare la richiesta GET di Postman.

Premendo Invia, la richiesta restituirà tutte le informazioni delle tabelle.

Creare un record di tabella

Utilizzando un POST e l'ID tabella di cui sopra, è possibile creare un record di tabella dal sistema esterno. L'autorizzazione e l'intestazione rimarranno le stesse, ma l'URL della richiesta sarà leggermente diverso.

Innanzitutto, si deve determinare la tabella in cui si desidera creare un record. L'URL di richiesta seguirà sempre la seguente struttura:

https://.tulip.co/api/v3/tables//records

Una volta inserita, la richiesta avrà bisogno anche di un corpo per elaborare correttamente il POST. Lo schema delle colonne è riportato sopra nella sezione Test e può essere trovato nella documentazione dell'API. L'unica colonna completamente necessaria per il successo della richiesta è la colonna ID. Le altre colonne non aggiunte saranno memorizzate come null nel record della tabella al momento della creazione. Aggiungere questo contenuto come corpo della richiesta.

Al momento dell'invio, Postman verifica che il record sia stato creato.

Avete trovato quello che cercavate?

Potete anche andare su community.tulip.co per porre la vostra domanda o vedere se altri hanno affrontato una domanda simile!