No hay comentarios

Pasos para configurar los mensajes de texto con CELL VOX

Contenido

Pasos para configurar los mensajes de texto con CELL VOX 1

Cuenta de cellVox 1

Portal de Cellbox 2

Número de cuenta 2

Api key 2

El API de Cellbox 3

Obtener Token 4

Enviar mensaje 6

Configuración del API en Golyat 8

Pasos para configurar los mensajes de texto con CELL VOX

Cellbox es una empresa dedicada a prestar servicios de comunicaciones móviles para empresas, gracias a un estudio de marketing realizado por el área de ventas se logró contactar con el área comercial de esa empresa que nos proporcionó la información necesaria para lograr conectar Golyat con los servicios de cellvoz

Cuenta de cellVox

En la página principal de Cellbox existe un botón para acceder y crear una cuenta o puedes acceder directamente en este link https://register.cellvoz.com , aquí podrás llenar un formulario muy sencillo que te solicita los datos de la cuenta, a partir de este momento es importante que registres un correo electrónico asignado al cliente que te va a servir para recuperar contraseña y para recibir los extractos mensuales de los gastos de la cuenta

Portal de Cellbox

Después de crear tu cuenta, tendremos acceso al portal de servicios a los que tienes acceso para integrar con el sistema Golyat, por el momento usaremos el servicio de API para conectarnos. Usaremos 2 datos importantes el número de cuenta y el api key.

Número de cuenta

El número de cuenta que nos asigna Cellbox al momento de crear la cuenta, aparece en la parte superior del portal al lado derecho debajo del nombre de la cuenta.

Api key

El api key corresponde a un código codificado que ayuda a mantener la seguridad del api, esto se logra debido a que este código contiene la información de la cuenta y la IP que tiene permitido, son claves privadas que no deben ser compartidas y que deben mantenerse protegidos ya que el compartir estos datos puede hacer que otras personas usen el saldo de la cuenta para fines personales.

Para generar este api key es necesario que ingreses al menú API y dentro de este menú ingreses al dirección ip donde está el sistema Golyat instalado para producción, también puedes incluir las ips de los ambientes de pruebas pero no es aconsejable.

De la misma manera no es aconsejable que coloque la url general 0.0.0.0, lo mejor es asignar la dirección del ambiente de producción así se tendrá mejor control del saldo de la cuenta

El api key se puede copiar cuando sea necesario

El API de Cellbox

Cell box cuenta con la página web http://apidoc.cellvoz.com/ en donde aclara el funcionamiento de servicios rest que tienen dispuestos para que las empresas puedan conectarse y enviar SMS a los clientes, vamos a ver las funcionalidades que son necesarias para conectar Golyat, pero en caso que tengas alguna duda siempre puedes usar esta documentación para aclarar con mayor detalle alguna duda.

Obtener Token

Una de las funcionalidades iniciales que usaremos es la de autenticarnos y generar un token que nos servirá de código de autorización en el servicio de enviar mensajes.

Vamos a usar la herramienta postman para conseguir el token de autorización, para esto debemos:

  1. Crear un nuevo request en postman
  2. Seleccionar que sea de tipo POST
  3. Colocar la url de producción que nos facilitan en la documentación
  4. En el body de la petición, organizar un texto como se visualiza en la imagen que envía el número de cuenta y la clave de la cuenta
  5. Cuando termines de organizar el body ya deberías poder ejecutar presionando el botón send

Como resultado de esta petición obtendrás en la respuesta el token, es el valor que se encuentra entre comillas.

Aun así lo que vamos a necesitar es crear un bearerAuth y este tipo de autenticación se logra simplemente colocando la palabra “Bearer “, antes del token que generamos (ten cuidado es la palabra y un espacio en blanco son 7 caracteres):

“Bearer “ + token

Aun asi si tienes dudas puedes usar postman para generar el bearerAuth, para ello:

  1. Vamos a la pestaña autorización de un request
  2. Seleccionamos el Type, bearer Token
  3. Y por último colocamos el token que obtuvimos como resultado del servicio login

  1. Pasamos a las variables del header y podemos ver como la variable Authorization contiene el texto que necesitamos, solamente necesitamos copiarlo para tenerlo disponible

Enviar mensaje

El objetivo de este instructivo es lograr la integración para enviar mensajes de texto a través de api de la empresa de servicios Cellbox, antes de hacer la configuración del sistema Golyat para este envío de mensajes, vamos a validar que el api se encuentre funcionando con normalidad para esto vamos a enviar la petición con la herramienta PostMan.

La documentación nos facilita la estructura del request, debemos tener antes el api key, el bearerAuth, también debemos tener el numero del teléfono que deseamos que reciba el mensaje de texto, junto con el código del país (para Colombia es 57), el mensaje que deseamos enviarle al clientes y por ultimo un tipo de mensaje, no vamos a detallar que es cada tipo solamente para esta integración necesitaremos mensajes de una sola vía que son la opción 1.

 

Para realizar nuestra prueba vamos a usar PostMan siguiendo estos pasos:

  1. Crear un nuevo request
  2. Asignar el request de tipo POST
  3. Colocar la url del servicio de envío de mensajes https://api.cellvoz.co/v2/sms/single

  1. Colocar en el header las variables de
    1. Api-key: que la obtienes en la sección api key
    2. Authorization: que la obtienes del servicio anterior de obtener el token

  1. Generar el cuerpo de la petición colocando la estructura de la imagen, debes tener en cuenta que la variable type en este instructivo será 1
  2. Ten ciudad en seleccionar que sea la opción raw y que este en formato Json

  1. Al presionar el botón send encontraras en la respuesta las instrucciones que te indican si el mensaje fue correcto o el motivo por el cual el mensaje no fue correcto

Configuración del API en Golyat

El sistema Golyat es un sistema que se encuentra en constante evolución, parte de esta evolución implica bastante cambios en su configuración por ello te pedimos validar cada paso para certificar que todavía este vigente.

  1. Creas un servidor con la URL del api de Cellbox, este servidor solo tiene la url y tipo WEB SERVER

  1. Creas una api que contiene el template que deseamos enviar a CELL BOX, el servidor es el que acabamos de crear un paso antes y el nombre es el que del analista

{

«number»: «57{{D_TEL_CASUAL}}»,

«message»: «Tu guia #{{E_CODE}} se ha entregado si quieres ver con mayor detalle porfavor ingresa a https://logimax.com.co/rastreo-guia.html»,

«type»: «1»

}

  1. Después tienes que configurar las propiedades del api, tienes que configurar en el header 3 propiedades Authentication, el api-key y el Content-type, y debes configurar los campos del template que debemos reemplazar, que en el ejemplo de las imágenes son 2, el número de la guía y el teléfono

La configuración del header se hace con la propiedad API_HEADER, en el valor colocamos el nombre de la propiedad y en el motivo colocamos el texto que debe llevar esta propiedad

La configuración de los campos depende de donde se ubica el dato que necesitamos, existen 3 orígenes de datos:

  1. Campos del formulario que realiza la acción
  2. Campos del documento que se gestionó en esa acción
  3. Campos especiales que pueden ser la fecha actual o el id del documento

Para los dos primeros se crea la propiedad y en la sección de las relaciones de esa propiedad se coloca la ruta para que el sistema identifique de donde sacar los campos que necesitamos

Para los campos especiales en la documentación se expone como funciona cada campo especial por eso es recomendable ver la documentación

  1. Por ultimo configurar el api en la transacción que se desea aplicar, en este ejemplo le colocamos este api a la transición cuando se genera una guía de contado, debemos ubicar la transición y crearle una propiedad API, en el valor colocar el nombre del API, al darle guardar el sistema adecuara y validara que el api exista

  1. Finalmente debes realizar las pruebas de funcionamiento, en la trazabilidad encontraras una opción que te permite visualizar el resultado de la ejecución del API, en el ejemplo de este instructivo se visualizara en la trazabilidad de la creación de una guía de contado.

También podría gustarte
Tags: Manuales

Más publicaciones similares

Deja una respuesta

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Rellena este campo
Rellena este campo
Por favor, introduce una dirección de correo electrónico válida.
Necesita estar de acuerdo con los términos para continuar

Menú
× ¿Cómo podemos ayudarte?