Guía del Usuario
  • Introducción
  • Notas de la versión
  • SUITE COMPOSER
    • Presentación
    • Comunidad y desarrolladores
    • Políticas de Privacidad
  • FUNDAMENTOS
    • Fundamentos de la interacción
      • Interacciones de voz
      • Interacción: Lenguaje Natural
      • Modelos dirigidos por la Intención
    • Construyendo el diálogo
    • Escenas
    • Diseño de Interacciones
    • Bibliografía
  • COMENZANDO
    • Guía de Instalación
      • Introducción
      • Guía de Instalación
      • Raspberry Pi
    • Utilidad de línea de comando
      • Introducción
      • Configuración de Servicios
      • Certificados
      • Generación de JWT Token
    • Primera Interacción
      • Introducción
      • Funcionalidades Nativas
    • Solución de problemas
  • DESARROLLADORES
    • Introducción
    • Extensiones: Appx
      • Integración
      • Entrenando un dataset personalizado
    • Community SDK
    • Documentación (API)
  • Comunidad
  • Políticas de Privacidad
Con tecnología de GitBook
En esta página
  1. DESARROLLADORES

Documentación (API)

Suite Composer te permitirá conectarte desde el exterior mediante la API pública. Entre otras cosas te dejará iniciar sesión (obtener token), administrar usuarios, entrenar y más.

AnteriorEntrenando un dataset personalizado

Última actualización hace 1 año

Autenticación

Este endpoint desempeña un papel fundamental en la Suite, proporcionando funcionalidades esenciales para la seguridad y la gestión de usuarios. Puedes aprovechar este servicio para autenticarte y obtener un token de acceso. La autenticación es un proceso crítico que garantiza que solo los usuarios autorizados puedan acceder a las diversas funciones y servicios ofrecidos por Suite.

Además de ser la puerta de entrada a la plataforma, este servicio es la clave para establecer la identidad y la autorización de los usuarios, lo que contribuye a mantener un entorno seguro y protegido.

Usuarios

Estos endpoints conforman la columna vertebral de la administración de usuarios en Suite, ofreciendo funcionalidades clave para la creación, modificación, obtención y eliminación de cuentas de usuario dentro del sistema.

Para interactuar con estos servicios, es imprescindible estar autenticado mediante un token válido, garantizando así un control de acceso seguro y protegido. A través de estos servicios, puedes agregar nuevos usuarios, recuperar información detallada sobre usuarios existentes o eliminar cuentas según sea necesario.

retrieve-users

get
Parámetros de encabezado
Content-TypestringOpcionalExample: application/x-www-form-urlencoded
AuthorizationstringOpcionalExample: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8
Respuestas
200
Successful response
application/json
get
GET /api/admin/users HTTP/1.1
Host: 127.0.0.1:8080
Accept: */*
200

Successful response

Sin contenido

delete-user

delete
Parámetros de encabezado
Content-TypestringOpcionalExample: application/x-www-form-urlencoded
AuthorizationstringOpcionalExample: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8
Respuestas
200
Successful response
application/json
delete
DELETE /api/admin/users/2 HTTP/1.1
Host: 127.0.0.1:8080
Accept: */*
200

Successful response

Sin contenido
  • Autenticación
  • POSTauthenticate
  • Usuarios
  • POSTadd-user
  • GETretrieve-users
  • DELETEdelete-user

authenticate

post
Parámetros de encabezado
Content-TypestringOpcionalExample: application/x-www-form-urlencoded
Cuerpo
usernamestringOpcionalExample: admin
passwordstringOpcionalExample: admin
Respuestas
200
Successful response
application/json
post
POST /api/auth/authenticate HTTP/1.1
Host: 127.0.0.1:8080
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 39

"username='admin'&password='admin'"
200

Successful response

Sin contenido

add-user

post
Parámetros de encabezado
Content-TypestringOpcionalExample: application/x-www-form-urlencoded
AuthorizationstringOpcionalExample: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8
Cuerpo
firstnamestringOpcionalExample: Nahuel
lastnamestringOpcionalExample: Proietto
usernamestringOpcionalExample: Nahue
adminintegerOpcionalExample: 0
passwordstringOpcionalExample: admin
emailstringOpcionalExample: nahuelproietto@admin.com
Respuestas
200
Successful response
application/json
post
POST /api/admin/users HTTP/1.1
Host: 127.0.0.1:8080
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 129

"firstname='Nahuel'&lastname='Proietto'&username='Nahue'&admin='0'&password='admin'&email='nahuelproietto@admin.com'"
200

Successful response

Sin contenido