Guía de la API para operadores

Prev Next

Descubre cómo configurar la API para operadores

Advanced Content

This article assumes previous experience with APIs.

Es necesario añadir operadores a tu sitio para completar la lista de usuarios que ejecutarán las aplicaciones desarrolladas en Tulip. Puedes crear operadores de dos maneras:* En la página «Usuarios», situada en «Configuración»* Utilizando un sistema externo a través de la API de Tulip.

El procedimiento que se muestra a continuación explica cómo utilizar la API de Tulip para crear operadores.

Añadir un token de la API de operadores

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

En tu instancia de Tulip, haz clic en el icono de tu perfil situado en la esquina superior derecha y selecciona «Configuración».

Configuring Your Tulip Account Settings_124925135

Selecciona «API de Tulip» y, a continuación, haz clic en el botón «Crear cuenta de servicio » situado en la esquina superior derecha.

Create%20API%20token1

En el menú de creación, asigna un nombre al token de la API y selecciona el ámbito «users:write ». Haz clic en «Crear».

Create API Token

Note

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.

Uso de la API de operador

A continuación se explica cómo crear un operador. En este caso, el ejemplo utilizará Postman para llevar a cabo la creación.

En primer lugar, añade tu punto final de la API a la solicitud POST.

NOTE

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

https://(nombrede tuinstanciaquí).tulip.co/api/v3/w/(espacio de trabajo)/users

A continuación, en «Autorización», selecciona «Autenticación básica» e introduce la clave de la API como nombre de usuario y el secreto de la API como contraseña.

En «Headers», añade el encabezado «Auth».

En el «Cuerpo», configura la solicitud para que incluya el objeto JSON. El formato genérico de esta solicitud es el siguiente:

{"role": "operator","name": "string","badge_id": "string"}

El resultado tendrá un aspecto similar a este:

Haz clic en «Enviar» para ejecutar la solicitud y recibirás una respuesta 201 que indica que se ha realizado correctamente. Para verificarlo, puedes consultar tu lista de usuarios en «Configuración» y confirmar que el usuario se ha creado correctamente.

Si la solicitud ha fallado, comprueba que la clave y el secreto sean correctos. Para obtener más información sobre códigos de respuesta específicos, consulta Introducción a las API.


¿Has encontrado lo que buscabas?

¡También puedes visitar community.tulip.co para publicar tu pregunta o ver si otros usuarios se han encontrado con un problema similar!