Documentación Técnica

Scopes

Son los permisos que otorga el Merchant para que la aplicación pueda acceder solo a los datos de los scopes seleccionados.

Estos se pueden otorgar a nivel global o seleccionar un recurso específico perteneciente al alcance. En el JSON del scope podrá encontrar el detalle de acceso según el recurso asociado, se indica con “true” o “false” si la aplicación tiene habilitado ese permiso:

  • “all”: La aplicación tendrá permiso a todos los recursos asociados a ese scope.
  • “xxxxxxxxx-xxxx-xxxx-xxxxxxxxxxxxxxxx”: La aplicación tendrá permiso al _id del recurso asociado al alcance.

Por ejemplo:

El Merchant otorga el alcance “read: stock”, como el stock varia según la bodega. El Merchant puede seleccionar otorgar acceso a todas sus bodegas oa una/varias bodegas específicas. 

 

 

En este caso en el json del scope el valor del campo “all” es “false” por lo que la aplicación no tiene acceso a todas las bodegas. Pero tiene acceso a la bodega con id = "xxxxxxxxx-3736-4f94-8xxx-xxxxxxxxxxxxxxx".

 

Si el merchant otorga permisos "all", deberá consultar el endpoint correspondiente según sea el caso para obtener el listado de todos los recursos.

 

Tipos de scope:

  • Read: Otorga permisos de solo lectura para el scope seleccionado.
  • Write: Otorga permisos de escritura para el scope seleccionado.
  • Manage: Otorga permisos para administrar(lectura/escritura) los recursos del scope seleccionado de forma global, no permite seleccionar por recurso.

Los diferentes scopes que tenemos disponibles son los siguientes:

  • Permisos para consultar/escribir los productos, sus versiones, categorías, color, talla, entre otros. Se otorga acceso global.
      • read:products
      • write:products
  • Permisos para consultar/escribir el stock de los productos según las bodegas. Se puede otorgar acceso a global o segmentado.
      • read:stocks
      • write:stocks
  • Permisos para consultar/escribir el precio de los productos según las listas de precios. Se puede otorgar acceso a global o segmentado.
      • read:prices
      • write:prices
  • Permisos para consultar/escribir/administrar las ventas de los diferentes canales de venta. Se puede otorgar acceso a global o segmentado.
      • read:checkouts
      • write:checkouts
      • manage:checkouts Este scope se debe habilitar solo para las aplicaciones que son canales de venta.
  • Permisos para consultar/escribir/administrar la asociación de una versión de un producto a los diferentes canales de venta. Se puede otorgar acceso a global o segmentado por canal.
      • read:product_links
      • write:product_links
      • manage:product_links Este scope se debe habilitar solo para las aplicaciones que son canales de venta.
  • Permisos para consultar/escribir/administrar las bodegas que tiene creadas el merchant. Se puede otorgar acceso a global o segmentado.
      • read:warehouses
      • write:warehouses
      • manage:warehouses

  • Permisos para consultar/escribir/administrar los clientes que tiene creados el merchant. Se puede otorgar acceso a global.
      • read:clients
      • write:clients
      • manage:clients

  • Permisos para consultar/escribir en las conexiones con couriers que tiene el merchant creada . Se puede otorgar acceso a global o segmentado.
      • read:couriers
      • write:couriers

  • Permisos para consultar los canales que tiene creados el merchant. Se puede otorgar acceso a global o segmentado.
      • read:channels

Si tienes dudas sobre este tema contáctanos a través de api@multivende.com y estaremos felices de ayudarte.

Equipo Integraciones API Multivende