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

post

/api/auth/authenticate

Header parameters

Content-Typestring

Example: application/x-www-form-urlencoded

Body

usernamestring

Example: admin

passwordstring

Example: admin

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://127.0.0.1:8080/api/auth/authenticate' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'username=admin&password=admin'

200

200

No body

Successful response

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

post

/api/admin/users

Header parameters

Content-Typestring

Example: application/x-www-form-urlencoded

Authorizationstring

Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8

Body

firstnamestring

Example: Nahuel

lastnamestring

Example: Proietto

usernamestring

Example: Nahue

admininteger

Example: 0

passwordstring

Example: admin

emailstring

Example: [e-mail]

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://127.0.0.1:8080/api/admin/users' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data 'firstname=Nahuel&lastname=Proietto&username=Nahue&admin=0&password=admin&email=[e-mail]'

200

200

No body

Successful response

retrieve-users

get

/api/admin/users

Header parameters

Content-Typestring

Example: application/x-www-form-urlencoded

Authorizationstring

Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://127.0.0.1:8080/api/admin/users'

200

200

No body

Successful response

delete-user

delete

/api/admin/users/2

Header parameters

Content-Typestring

Example: application/x-www-form-urlencoded

Authorizationstring

Example: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1Njk2Mzc1NTguNjIzNTI0LCJpc3MiOiJLaXR1cmUiLCJhZG1pbiI6dHJ1ZSwic3ViIjoiYWRtaW4ifQ.p-1x12EUoBmpCZRoTNTYlFxhFVh1OV8E5sjQ2InyIY8

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://127.0.0.1:8080/api/admin/users/2'

200

200

No body

Successful response