Usando a API do operador
  • 04 Nov 2023
  • 1 Minuto para Ler
  • Contribuintes

Usando a API do operador


Article Summary

Uso da API do operador

Como configurar a API do operador

A adição de Operators ao seu site é necessária para preencher os usuários que executarão os aplicativos desenvolvidos no Tulip. Tradicionalmente, os operadores são criados nas configurações pelos proprietários das contas. Você também pode criar esses operadores usando um sistema externo por meio da API da Tulip.

Como adicionar um token API de operador

Em seu site da Tulip, navegue até seu perfil no canto superior direito.

Selecione as opções de Configurações nesse menu.

Em Configurações, selecione a opção Tokens de API.

No lado direito dessa página, selecione Criar token de API.

Em Creation (Criação), dê um nome ao token de API e certifique-se de que ele tenha o escopo Users:Write (Usuários: Escrever) selecionado e, em seguida, clique em Create (Criar).

Observação: certifique-se de salvar as informações do token de API para a chave de API, o segredo e o cabeçalho de autorização.

Como usar a API do operador

A seguir, veremos como criar um operador. Nesse caso, o exemplo usará o Postman para realizar a criação.

Primeiro, adicione seu endpoint de API à solicitação Post.

Em seguida, em Authorization (Autorização), selecione Basic Auth (Autenticação básica) e insira a API Key (Chave da API) como o Username (Nome de usuário) e o API Secret (Segredo da API) como a Password (Senha).

Em Headers (Cabeçalhos), adicione o Auth Header (Cabeçalho de autenticação).

Em Body (Corpo), formate a solicitação para receber o objeto JSON. O formato genérico para essa solicitação é o seguinte.

{ "role": "operator" (operador), "name" (nome): "string", "badge_id": "string" }

Isso terá a seguinte aparência:

Pressione enviar para executar a solicitação e você receberá uma resposta 201 para indicar o sucesso. Para verificar, verifique a lista de usuários em Configurações e confirme se o usuário foi criado com êxito.

Se a solicitação falhar, verifique se a chave e o segredo estão corretos. Para obter mais informações sobre códigos de resposta específicos, consulte a seção Documentação da API na página Tokens da API.


Encontrou o que estava procurando?

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


Este artigo foi útil?