Generar las claves de API
Solamente el usuario Master de la tienda tiene permisos para crear y administrar las llaves de la API appKeys y appTokens. El Master es aquel usuario cuyo email esta en la sección de Contacto Contact dentro de Account management > Accounts.
Para crear el par de credenciales, el usuario Master debe:
Ir a Account management > Accounts
2. En la página de configuración de su cuenta, en la sección llamada Seguridad (Security) selecciona Generate access key and secret, serás direccionado a una pantalla donde puedes darle nombre al par de llaves que vas a generar. Puedes ingresar por ejemplo Integración - Wivo para identificar fácilmente a quién esta dirigida la llave.
3. Presiona "Generate new secret" y VTEX generará las claves de API. Por motivos de seguridad, el appToken llamado "secret" se muestra una sola vez cuando es creado. Copia este token y guárdalo en un lugar seguro, éste será uno de los requisitos que solicitaremos en nuestro formulario de integración.
4. El appKey llamada "Access Key" lo puedes encontrar en el campo a continuación:
Permisos
Una vez generadas, el par de credenciales appKey y appToken no estarán vinculadas a un rol por lo cual después de ser creado, se debe hacer esta asociación para definir los permisos otorgados a Wivo.
Crear un rol para Wivo
Ir a Account settings > Account management > Roles. En esta sección encontrarás un listado con todos los roles dentro de tu tienda.
2. Haz click en New Role para crear un nuevo rol
3. En esta pantalla, para el campo "Choose role" debes seleccionar Custom. De esta manera puedes elegir los productos y recursos que usuarios asignados a este rol pueden acceder.
4. Selecciona los siguientes recursos:
Productos | Categoría | Recursos | Descripción |
Catalog |
Content | Product Form; Brands; Categories; SKUs | Acceso a la pantalla de productos, SKU, Marcas y Categoías |
Checkout |
CheckoutResoures | Shopping Cart Full Access; Orders Full Access | Acceso a los carritos y órdenes de compra |
PCI Gateway | Payment-View Payment Data | View Payment Data | Acceso para leer transacciones |
Pricing | Price List | Read Prices | Permite recuperar los precios por producto |
VTEX Fulfilment | Fulfilment Resources | Orders Detail | Obtener detalle de fulfillment |
OMS |
AcessoOMS | View Orders; View store sales stats | Permite leer los detalles órdenes de compra en OMS |
Logistics |
Access to Logistics | Logistics viewer; Logistics inventory read only; Logistics shipping read only | Permite leer los detalle de envío e inventario |
5. Selecciona un nombre para el rol, puede ser por ejemplo "Integración Wivo"
6. Haz click en Guardar (Save)
Asociar el rol a la llave de API
En la sección de Seguridad (Security) donde está la llave que has generado, copia la appKey de la columna Access Key
2. Navega devuelta a Account Management y entra a la sección de Usuarios (Users)
3. Haz click en New User.
4. Dentro de la pantalla de creación de usuario, como email pega la appKey que obtuviste anteriormente.
5. En la sección de "Roles", selecciona el rol que creaste en el paso anterior para nuestra integración.
6. Haz click en Guardar (Save)