Esta documentación esta dirigida a los usuarios de hyperbloq que deseen contar con un nivel de acceso de tipo Citizen.

Para utilizar a los endpoints detallados aquí, es necesario contar con un ID De Espacio.

El mismo se utiliza como header (Application-Id) y en otros casos en la URL del request { space_id }.

Esta colección de Postman, además, contiene un Environment en el cual se puede reemplazar con sus credenciales y datos para utilizar la API más facilmente.

Variables en el Envrionment

• space_id: "ID de Espacio"
• citizen_username: "Usuario Citizen"
• citizen_password: "Contraseña Citizen"
• app_user_username: "Usuario de App"
• app_user_password: "Contraseña de App".

Credenciales

Se proveen 2 tipos credenciales para acceder a la plataforma:

• Administrador de Espacio
• Citizen de Hyperbloq

Dentro de un espacio, se puede utilizar el usuario administrador de espacio para:

• Crear y modificar usuarios en el Espacio
• Crear, Leer, Actualizar, Eliminar Objetos en las colecciones del espacio.
• Subir, Listar, Visualizar Archivos dentro de un Bucket.

En cambio un usuario Citizen de Hyperbloq puede realizar las acciones listadas arriba y otras tareas administrativas de su cuenta como:

• Crear Espacios
  • Crear, Leer, Actualizar, y Eliminar Colecciones en un Espacio.
  • Crear, Leer, Actualizar, y Eliminar Buckets en un Espacio.

Para obtener sus credenciales contacte con tomas.r@hyperbloq.com.

Endpoints

Esta documentación está didivida en 2 partes:

Espacios

Contiene los endpoints destinados al uso de un administrador de espacio o los usuarios que pertenecen al mismo.

Administración

Contiene los endpoints destinados al uso de un Citizen de Hyperbloq para administrar sus espacios, colecciones, y buckets.