Activación Suscripción a RSales API

Para utilizar la API de RSales es necesario activar la suscripción desde el portal de administración. A continuación se describe el proceso paso a paso.

---

Requisitos previos

• Tener acceso al portal ventasremotas.com.
• Contar con los datos de acceso del usuario Mega-administrador.

---

Paso 1: Iniciar sesión en el portal

Ingrese al portal ventasremotas.com utilizando sus credenciales de usuario Mega-administrador.

Importante

Solo los usuarios con rol Mega-administrador tienen permisos para activar la suscripción a la API.

---

Paso 2: Ir a Configuración General

Una vez dentro del portal, navegue a la sección:

Configuración → General

---

Paso 3: Ubicar la sección RSales API

Desplácese hasta la parte inferior de la página de Configuración General. Allí encontrará la sección RSales API con un interruptor (check) que permite encender o apagar el uso de la API.

---

Paso 4: Activar la suscripción

Active el interruptor (check) de la sección RSales API. Al hacerlo, se abrirá un modal de confirmación con el mensaje:

“¿Está seguro de que desea activar la integración con RSales-API? Esta acción guardará la configuración actual”

Haga clic en el botón Aceptar para confirmar la activación.

---

Paso 5: Obtener los tokens de acceso

Una vez confirmada la activación, el sistema desplegará automáticamente los tokens de suscripción necesarios para realizar las llamadas a la API:

Campo	Descripción
Suscripción API KEY	Clave de suscripción (Subscription-Key) que debe enviarse en el encabezado de cada solicitud.
Cliente ID	Identificador único del cliente (client_id) utilizado para la autenticación.
Client secret	Secreto del cliente (client_secret) utilizado junto al client_id para obtener el token JWT.

Consejo

Utilice los botones de copiado ubicados junto a cada campo para copiar los valores de forma segura.

---

Siguientes pasos

Con los tokens de acceso obtenidos, ya puede comenzar a consumir la API de RSales. El siguiente paso es autenticarse para obtener un token JWT:

1. Utilice la Suscripción API KEY como valor del encabezado Subscription-Key.
2. Envíe el Cliente ID y Client secret como client_id y client_secret en el cuerpo de la solicitud al endpoint de Autenticación.
3. El token JWT obtenido tiene una vigencia de 1 hora y debe incluirse en el encabezado Authorization de las solicitudes posteriores.

Nota

Para más detalles sobre cómo autenticarse y obtener el token JWT, consulte la guía de Autenticación.

---

Costos asociados al uso de la API

Información de facturación

El uso de la API de RSales tiene un costo asociado que será facturado de forma automática. Es importante tener en cuenta lo siguiente antes de activar la suscripción.

Modelo de cobro

• El consumo de la API se factura por cada llamado realizado a cualquier endpoint.
• Cada solicitud (request) enviada a la API cuenta como una petición facturable, independientemente de si la respuesta fue exitosa o no.

Facturación

• El uso de la API se facturará a través del ítem “Consumos adicionales” en su factura regular de RSales.
• El valor acumulado del consumo puede consultarse en cualquier momento desde el portal ventasremotas.com en la sección Consumos adicionales.

Consultar el consumo actual

Para verificar el consumo acumulado de la API:

1. Ingrese al portal ventasremotas.com.
2. Navegue a la sección Consumos adicionales.
3. Allí podrá visualizar el total consumido (USD) y la cantidad de peticiones realizadas.

Recomendación

Revise periódicamente su consumo en la sección de Consumos adicionales para mantener un control adecuado del uso y los costos asociados a la API.