Cómo utilizar la API de operador
  • 22 Oct 2024
  • 1 Minuto para leer
  • Colaboradores

Cómo utilizar la API de operador


Resumen del artículo

Aprenda a configurar la API de operador

Access Tulip's API documentation here.

:::(Info) (Contenido Avanzado)Este artículo asume experiencia previa con APIs:::

Añadir operadores a tu sitio es necesario para poblar los usuarios que ejecutarán las Apps desarrolladas en Tulip. Puedes crear Operadores de dos maneras:* La página de Usuarios, ubicada en Configuración* Utilizar un sistema externo a través de la API de Tulip.

El siguiente procedimiento muestra cómo utilizar la API de Tulip para crear operadores.

Añadir un token de API de operador

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

Configuring Your Tulip Account Settings_124925135

Seleccione API Tokens y haga clic en el botón Crear API Token en la parte superior derecha.

Create%20API%20token1

En el menú de creación, asigne un nombre al token de API y seleccione el ámbito users:write. Haga clic en Crear.

Create API Token

:::(Info) (Nota)Asegúrese de guardar la información del token de API para la clave de API, el secreto y el encabezado de autorización:::

Uso de la API de operador

A continuación veremos cómo crear un operador. En este caso, el ejemplo utilizará Postman para realizar la creación.

En primer lugar, añade tu endpoint API a la petición Post.

:::(Info) (NOTA) Si está utilizando una clave de API global, debe especificar el espacio de trabajo. Si su clave de API tiene un ámbito de espacio de trabajo, es opcional.:::

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users

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

En Cabeceras, añada la Cabecera Auth.

En el cuerpo, formatee la solicitud para recibir el objeto JSON. El formato genérico para esta solicitud es el siguiente.

{"rol": "operator", "name": "cadena", "badge_id": "cadena"}

Esto se parecerá a esto:

Haga clic en Enviar para ejecutar la solicitud, y recibirá una respuesta 201 para indicar el éxito. Para verificarlo, puede comprobar su lista de usuarios en Configuración y confirmar que el usuario se ha creado correctamente.

Si la solicitud falló, compruebe que la Clave y el Secreto son correctos. Para obtener más información sobre códigos de respuesta específicos, consulte Introducción a las API.


¿Ha encontrado lo que buscaba?

También puedes dirigirte a community.tulip.co para publicar tu pregunta o ver si otras personas se han enfrentado a una pregunta similar.


¿Te ha sido útil este artículo?