This article assumes previous experience with APIs.
Consulte os artigos sobre Tabelas, Operadores e Máquinas para saber como configurar a chave da API.
Use os conectores do Tulip para testar a API do Tulip
Prior to r383, Service Accounts were called "API Tokens".
Leia as instruções sobre como configurar um conector e como configurá-lo usando a conta de serviço da API que você configurou (consulte este artigo sobre como configurar uma conta de serviço).
Depois de configurar seu conector, clique em “Criar função”. Neste exemplo, vamos explicar como obter registros de uma tabela.
Primeiro, você precisa formar uma solicitação usando GET, POST, PUT, HEAD, PATCH ou DELETE e, em seguida, especificar a URL específica para a qual deseja enviar a solicitação (leia aqui para obter mais informações sobre os recursos da nossa 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://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records
Certifique-se de adicionar sua autenticação (da própria Conta de Serviço), cabeçalhos de solicitação (se necessário) e parâmetros de consulta (seja na própria URL ou nos parâmetros de consulta — leia como definir parâmetros de consulta para obter informações adicionais).
Além disso, você pode especificar quaisquer entradas ou saídas que a função do conector possa precisar para enviar de volta a um aplicativo ou automação.
Usando o Postman para testar a API do Tulip
A seguir, explicaremos como criar um operador. Neste caso, o exemplo utilizará o Postman para realizar a criação.
Primeiro, adicione seu endpoint da API à solicitação POST.
Em seguida, na seção “Autorização”, selecione “Autenticação Básica” e insira a chave da API como “Nome de usuário” e o segredo da API como “Senha”.
Em “Headers”, adicione o cabeçalho “Auth”.
No Corpo, formate a solicitação para incluir o objeto JSON. O formato genérico para essa solicitação é o seguinte.
{"role": "operator","name": "string","badge_id": "string"}
Ficará mais ou menos assim:
Clique em “Enviar” para executar a solicitação e você receberá uma resposta 201 indicando sucesso. Para verificar, você pode conferir sua lista de usuários em “Configurações” e confirmar se o usuário foi criado com sucesso.
Se a solicitação falhar, certifique-se de que a chave e o segredo estejam corretos. Para obter mais informações sobre códigos de resposta específicos, consulte a seção “Documentação da API” na página da API do Tulip.
Usando a documentação da API para testar a API do Tulip
Nas configurações do seu Espaço de Trabalho ou da sua Conta, acesse a API da Tulip. De lá, clique em “Saiba mais” ao lado da opção “Criar conta de serviço”.
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 diversos usos.
Essa página também contém a URL do servidor necessária para configurar solicitações de API a partir de sistemas externos. Para se familiarizar com a API, clique no botão “Autorizar”.
Esse botão fornecerá mais informações sobre a configuração da API para fins de teste. Nos campos, insira o seguinte:
- Nome de usuário: Chave da API
- Senha: Segredo
Clique em “Autorizar” e você poderá começar a testar algumas solicitações HTTP comuns para tabelas.
Cada uma das opções nesta página pode ser expandida e testada. Cada solicitação fornece informações úteis sobre as respostas correspondentes.
Nesta página, também há informações sobre esquemas para alguns dos componentes do Tulip. Por exemplo, para criar um registro na tabela, é útil conhecer a formatação JSON adequada para cada coluna. Exemplo de esquema para colunas mostrado abaixo:
