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.

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.

authenticate

POSThttps://127.0.0.1:8080/api/auth/authenticate

Header parameters

Body

application/x-www-form-urlencoded

usernamestring

passwordstring

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://127.0.0.1:8080/api/auth/authenticate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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.

add-user

POSThttps://127.0.0.1:8080/api/admin/users

Header parameters

Body

application/x-www-form-urlencoded

firstnamestring

lastnamestring

usernamestring

admininteger

passwordstring

emailstring

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://127.0.0.1:8080/api/admin/users', {
    method: 'POST',
    headers: {
      "Content-Type": "application/x-www-form-urlencoded"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

retrieve-users

GEThttps://127.0.0.1:8080/api/admin/users

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://127.0.0.1:8080/api/admin/users', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

delete-user

DELETEhttps://127.0.0.1:8080/api/admin/users/2

Header parameters

Response

200

Successful response

Body

application/json

any

Request

JavaScriptCurl

const response = await fetch('https://127.0.0.1:8080/api/admin/users/2', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();