Configure e utilize a API da Tulip para interagir com a Tulip a partir de outros sistemas.
This article assumes previous experience with APIs.
O Tulip interage com as APIs de muitos outros sistemas por meio de conectores. Usando conectores, um aplicativo do Tulip pode iniciar uma consulta HTTP ou SQL.
Em outros casos, talvez você queira permitir que um sistema externo consulte dados que existem apenas no Tulip. É possível se comunicar com o Tulip a partir de sistemas externos usando a API do Tulip. Este artigo orientará você na configuração e nos testes da API do Tulip.
A API do Tulip é útil para integrar esses sistemas externos ao Tulip de várias maneiras. Atualmente, a API funciona apenas com tabelas do Tulip. Isso pode incluir atualizar um registro da tabela com novas informações, criar uma tabela ou obter a contagem de registros em uma tabela.
Funcionalidade da API de Estações
A API de Estações pode ajudá-lo a gerenciar e integrar novas estações rapidamente. A funcionalidade geral consiste em criar, listar e modificar estações, grupos de estações e interfaces (anteriormente conhecidas como dispositivos de exibição). Leia mais aqui.
Por exemplo, você pode escrever um script que permita enviar automaticamente um link para configurar uma nova interface sempre que um novo usuário for cadastrado.
Passo a passo
Prior to r383, Service Accounts were called "API Tokens".
Configurar a API de Estações
Consulte este artigo para saber como configurar uma conta de serviço.
If you have a Service Account already set up, you may use that API Key and Secret
- Nas Configurações da conta, selecione a aba API do Tulip.
- Clique em “Criar conta de serviço”.
- Dê um nome à sua conta de serviço.
- Em “Escopos”, selecione
“stations: read” e“stations: write”:
Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- Clique em “Salvar”.
Use a API de Estações
Depois de configurar a API Stations, você pode criar uma estação. Este exemplo usa o Postman para realizar a criação.
- Adicione seu endpoint da API à solicitação POST.
- Em “Headers”, adicione o cabeçalho “Auth”.
- No “Body”, formate a solicitação para incluir o objeto JSON. O formato genérico para essa solicitação é o seguinte:
Ao formular a solicitação, inclua o espaço de trabalho. Exemplo:<nome-da-sua-instância>.tulip.co/api/stations/v1/w/1/stations Este exemplo acessa o endpoint “stations”. Se você não tiver um espaço de trabalho, deve defini-lo como 1.
- Clique em “Enviar” para executar a solicitação e você receberá uma resposta 200, indicando sucesso.
Para verificar, acesse a página “Estações”, na guia “Chão de fábrica ”, e confirme se a estação foi criada.
