Roles

Es la entidad que almacena la información específica de los distintos roles (tipos) de usuarios. Ya que un usuario puede tener uno o múltiples roles (pertenecer a uno o varios tipos de usuarios).

Listado de todos los roles de usuarios

GET https://tiendagoshop.com/api/v1/user_roles

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

200

{
  "user_roles": [
    {
      "id": 3,
      "name": "user",
      "label": "Cliente",
      "ext_id": null,
      "is_default": true,
      "admin_accessible": false,
      "permission_sets": [
        {
          "id": 1,
          "name": "default",
          "created_at": "2020-09-25T10:55:49.609Z",
          "updated_at": "2020-09-25T10:55:49.611Z",
          "description": "Permisos por defecto para todos los usuarios, incluyendo clientes. Nota: usuarios sin este permiso no pueden hacer pedidos.",
          "display_permission": false
        }
      ]
    },
    {
      "id": 2,
      "name": "admin",
      "label": "Admin",
      "ext_id": null,
      "is_default": false,
      "admin_accessible": true,
      "permission_sets": [
        {
          "id": 2,
          "name": "admin",
          "created_at": "2020-09-25T10:55:49.681Z",
          "updated_at": "2020-09-25T10:55:49.682Z",
          "description": "Gestionar todo",
          "display_permission": false
        },
        {
          "id": 1,
          "name": "default",
          "created_at": "2020-09-25T10:55:49.609Z",
          "updated_at": "2020-09-25T10:55:49.611Z",
          "description": "Permisos por defecto para todos los usuarios, incluyendo clientes. Nota: usuarios sin este permiso no pueden hacer pedidos.",
          "display_permission": false
        },
        {
          "id": 1,
          "name": "default",
          "created_at": "2020-09-25T10:55:49.609Z",
          "updated_at": "2020-09-25T10:55:49.611Z",
          "description": "Permisos por defecto para todos los usuarios, incluyendo clientes. Nota: usuarios sin este permiso no pueden hacer pedidos.",
          "display_permission": false
        }
      ]
    },
    {
      "id": 4,
      "name": "affiliate",
      "label": "Afiliado",
      "ext_id": null,
      "is_default": false,
      "admin_accessible": false,
      "permission_sets": [
        {
          "id": 1,
          "name": "default",
          "created_at": "2020-09-25T10:55:49.609Z",
          "updated_at": "2020-09-25T10:55:49.611Z",
          "description": "Permisos por defecto para todos los usuarios, incluyendo clientes. Nota: usuarios sin este permiso no pueden hacer pedidos.",
          "display_permission": false
        }
      ]
    }
  ],
  "count": 3,
  "current_page": 1,
  "pages": 1
}

Crear un nuevo rol de usuario.

POST https://tiendagoshop.com/api/v1/user_roles

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

Request Body

Name	Type	Description
name	string	Nombre del rol.
label	string	Etiqueta del rol.
is_default	boolean	Opción de predefinido
admin_accessible	boolean	Opción de usuario administrador.
permission_set_ids	array	Array de integers, con los permisos para el rol.

200

{
  "id": 6,
  "name": "gestor_catalogo",
  "label": "Gestor catalogo",
  "ext_id": null,
  "is_default": false,
  "admin_accessible": true,
  "permission_sets": [
    {
      "id": 6,
      "name": "Product Display",
      "created_at": "2020-09-25T10:55:50.684Z",
      "updated_at": "2020-09-25T10:55:50.699Z",
      "description": "Ver Productos",
      "display_permission": true
    },
    {
      "id": 7,
      "name": "Product Management",
      "created_at": "2020-09-25T10:55:50.817Z",
      "updated_at": "2020-09-25T10:55:50.832Z",
      "description": "Gestionar Productos",
      "display_permission": false
    }
  ]
}

Modificar un rol de usuario existente.

PUT https://tiendagoshop.com/api/v1/user_roles/:id

Path Parameters

Name	Type	Description
id	integer	ID del rol.

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

Request Body

Name	Type	Description
name	string	Nombre del rol
label	string	Etiqueta del rol
is_default	boolean	Opción de predefinido
admin_accessible	boolean	Opción de usuario administrador.
permission_set_ids	array	Array de integers, con los permisos para el rol.

200

{
  "id": 6,
  "name": "gestor_catalogo",
  "label": "Gestor Catálogo",
  "ext_id": null,
  "is_default": false,
  "admin_accessible": true,
  "permission_sets": [
    {
      "id": 6,
      "name": "Product Display",
      "created_at": "2020-09-25T10:55:50.684Z",
      "updated_at": "2020-09-25T10:55:50.699Z",
      "description": "Ver Productos",
      "display_permission": true
    },
    {
      "id": 7,
      "name": "Product Management",
      "created_at": "2020-09-25T10:55:50.817Z",
      "updated_at": "2020-09-25T10:55:50.832Z",
      "description": "Gestionar Productos",
      "display_permission": false
    }
  ]
}

Eliminar un rol de usuario existente.

DELETE https://tiendagoshop.com/api/v1/user_roles/:id

Path Parameters

Name	Type	Description
id	integer	ID del rol.

Headers

Name	Type	Description
X-Spree-Token	string	Token generado desde el CMS de GS

204