Como usar a API de tabela

Finalidade

Configurar e usar a API da Tulip para interagir com a Tulip a partir de outros sistemas.

Observação: Artigo avançado.

Pressupõe experiência prévia com APIs.

:::(Info) (NOTA) Artigo avançado: Pressupõe experiência prévia com APIs :::

A Tulip interage com muitas APIs de outros sistemas por meio de conectores. Usando conectores Um aplicativo Tulip pode iniciar uma consulta HTTP ou SQL.

Em outros casos, você pode querer permitir que um sistema externo consulte dados que só existem na Tulip. É possível se comunicar com a Tulip a partir de sistemas externos usando a API da Tulip. Este artigo abordará a configuração e os testes da API da Tulip.

A API da Tulip é útil para integrar esses sistemas externos com a Tulip de várias maneiras. A API atualmente só funciona com tabelas da Tulip. Isso pode incluir a atualização de um registro de tabela com novas informações, a criação de uma tabela ou a obtenção da contagem de registros em uma tabela.

Como adicionar uma API

Navegue até a página de Configurações de sua conta Tulip.

No menu Settings (Configurações), selecione API Tokens (Tokens de API).

Essa página permite que você configure "Tokens de API", que são configurações de API equipadas com uma chave de API, segredo e cabeçalho de autorização. Para adicionar um token de API, selecione o botão Add API Token (Adicionar token de API) no canto superior direito dessa página. Quando selecionado, configure o token de API conforme desejado.

Dê um nome ao token de API e defina os escopos que ele terá permissão para executar. Neste exemplo, o token de API pode ler das tabelas Tulip e também gravar nelas. Os tokens de API podem ser arquivados se não estiverem em uso.

Ao clicar em Create (Criar), as informações da API serão fornecidas. Certifique-se de salvar essas informações, pois elas não poderão ser acessadas novamente!

Essas informações agora podem ser usadas para configurar uma conexão com a API da Tulip.

Testando a API

Feche o pop-up de informações e navegue até o botão API Documentation (Documentação da API), ao lado da opção Create API Token (Criar token de API).

Isso o levará a uma página que permite testar a API com a chave criada. Ela também fornece documentação e exemplos de corpos de solicitação para vários usos.

Essa página também contém o URL do servidor necessário para configurar solicitações de API de sistemas externos. Para se familiarizar com a API, clique no botão Authorize (Autorizar).

Esse botão fornecerá algumas informações adicionais sobre a configuração da API para fins de teste. Nos campos, digite o seguinte:

• Nome de usuário: Chave da API
• Senha: Segredo

Clique em Authorize e você poderá começar a testar algumas solicitações HTTP comuns para Tables.

Cada uma das opções dessa página pode ser expandida e testada. Cada solicitação fornece informações úteis sobre as respostas correspondentes.

Nessa página, também há informações sobre esquemas para alguns dos componentes do Tulip. Por exemplo, para criar um registro de tabela, é útil conhecer a formatação JSON apropriada para cada coluna. Exemplo de esquema para colunas mostrado abaixo:

Consultas com filtros

Os filtros podem ser muito úteis para extrair apenas os dados nos quais você está interessado. Às vezes, esses filtros podem ser um pouco complicados com sua sintaxe. A seguir, descrevemos como cada um é formado no exemplo de uma solicitação GET para registros, seguido de um exemplo completo.

Os nomes decampo para campos personalizados são sempre prefixados com um identificador de cadeia de cinco dígitos. Eles podem ser encontrados mais facilmente após uma solicitação GET all para verificar o nome verdadeiro do campo.

• Ex. "field"="maytq_scrap_count"

Os valores deargumento geralmente são diretos. Se for um valor de texto, certifique-se de colocá-lo entre aspas.

• Ex. "arg":15

Corresponda ao tipo de função que você gostaria de usar.

• Ex. "functionType": "greaterThan"

Uma solicitação completa para isso pode se parecer com o seguinte:

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

Vários filtros

Em alguns casos, você pode ter vários filtros para verificar na tabela. Nesse caso, você pode adicionar vários ao objeto filters. Isso pode ser parecido com o seguinte:

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

Exemplos

Os exemplos a seguir percorrerão o processo para fazer solicitações à API da Tulip. Esses exemplos usarão o Postman para fazer as solicitações do Tulip.

Obter nomes e informações de tabelas

Essa solicitação Get permite que o sistema externo recupere os IDs e as informações das colunas de todas as tabelas dentro da instância da Tulip. Isso pode ser útil como um método para encontrar uma tabela de interesse a fim de configurar uma solicitação POST.

No Postman, defina a Autorização como Basic Auth e insira a Chave e o Segredo da API.

Agora, a solicitação precisa ir para o lugar certo. No Tulip, encontre a solicitação que você gostaria de fazer na documentação da API. Nesse caso, a solicitação é para obter todas as informações da tabela.

Para obter o URL da solicitação, execute o botão Executar e verifique as informações da solicitação.

Esse URL de solicitação pode ser usado como URL do servidor para processar a solicitação GET do Postman.

Pressione Send (Enviar), e a solicitação retornará todas as informações das tabelas.

Criar um registro de tabela

Usando um POST e o ID da tabela encontrado acima, um registro de tabela pode ser criado a partir do sistema externo. A autorização e o cabeçalho permanecerão os mesmos, mas o URL da solicitação será um pouco diferente.

Primeiro, determine a tabela na qual deseja criar um registro. O URL da solicitação sempre seguirá a seguinte estrutura:

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

Uma vez inserida, a solicitação também precisará de um corpo para processar o POST adequadamente. O esquema das colunas é fornecido acima na seção Testes e pode ser encontrado na documentação da API. A única coluna que é totalmente necessária para que isso seja bem-sucedido é a coluna ID. Todas as outras colunas que não forem adicionadas serão armazenadas como nulas no registro da tabela após a criação. Adicione esse conteúdo como um corpo para a solicitação.

No envio, o Postman verifica se o registro foi criado.

Encontrou o que estava procurando?

Você também pode acessar community.tulip.co para postar sua pergunta ou ver se outras pessoas tiveram uma pergunta semelhante!