Guida alle API di Stations

Configura e utilizza l’API di Tulip per interagire con Tulip da altri sistemi.

Tulip interagisce con le API di molti altri sistemi tramite i connettori. Utilizzando i connettori, un’app Tulip può avviare una query HTTP o SQL.

In altri casi, potresti voler consentire a un sistema esterno di interrogare dati presenti esclusivamente all’interno di Tulip. È possibile comunicare con Tulip da sistemi esterni utilizzando l’API di Tulip. Questo articolo illustrerà la configurazione e il collaudo dell’API di Tulip.

L’API di Tulip è utile per integrare questi sistemi esterni con Tulip in molti modi. Attualmente l’API funziona solo con le tabelle di Tulip; ciò può includere l’aggiornamento di un record di una tabella con nuove informazioni, la creazione di una tabella o il recupero del numero di record presenti in una tabella.

Funzionalità dell’API Stazioni

L’API Stazioni può aiutarti a gestire e integrare rapidamente nuove stazioni. La funzionalità generale consiste nel creare, elencare e modificare stazioni, gruppi di stazioni e interfacce (precedentemente note come dispositivi di visualizzazione). Per saperne di più, clicca qui.

Ad esempio, è possibile scrivere uno script che consenta di inviare automaticamente un link per configurare una nuova interfaccia ogni volta che si registra un nuovo utente.

Guida passo passo

Configurazione dell’API Stations

Consulta questo articolo per scoprire come configurare un account di servizio.

1. Nelle Impostazioni dell’account, seleziona la scheda API Tulip.
2. Fare clic su Crea account di servizio.
3. Assegna un nome al tuo account di servizio.
4. Per gli ambiti, seleziona stations: read e stations: write:

1. Fai clic su Salva.

Utilizza l'API Stations

Dopo aver configurato l'API Stations, puoi creare una stazione. In questo esempio si utilizza Postman per eseguire la creazione.

1. Aggiungi il tuo endpoint API alla richiesta POST.
2. In "Headers", aggiungi l'intestazione "Auth".

1. Nel campo "Body", imposta la richiesta in modo da includere l'oggetto JSON. Il formato generico per questa richiesta è il seguente:

Quando crei la richiesta, includi l'area di lavoro. Esempio:<nome-della-tua-istanza>.tulip.co/api/stations/v1/w/1/stations Questo esempio si rivolge all'endpoint "stations". Se non disponi di un'area di lavoro, dovresti impostare il valore su 1.

1. Fare clic su "Invia" per eseguire la richiesta; si riceverà una risposta 200 a indicare che l'operazione è andata a buon fine.

Per verificare, vai alla pagina "Stazioni", nella scheda "Reparto di produzione ", e controlla che la stazione sia stata creata.