Estimado Cliente:
La presente guía de conexión tiene como propósito el brindarle una visión completa de los distintos tipos de configuración que se tienen disponibles para la implementación del API – Web Service de Claro Notifícame SMS.
Le sugerimos leer el presente documento antes de realizar cualquier tipo de implementación, para poder seleccionar la que mejor se acople a su plataforma tecnológica.
1. Opciones de conexión API
A continuación se muestran las dos opciones disponibles para realizar la conexión al API
API REST: – https://url_pais/api/rest/
Descripción: La primera forma de conexión disponible es a través de la arquitectura REST (por sus siglas en inglés para Transferencia de Estado Representacional).
Ventaja: Este tipo de integración provee al usuario la funcionalidad más completa en cuanto a configuración ya que se puede tener acceso tanto al envío de mensajes como a la administración de grupos y contactos. También cuenta con un tipo de autenticación muy robusto, utilizando para el efecto los generadores de llaves: API KEY y API SECRET. Cada petición (Request) que se haga debe contener una firma única, la cual tiene un tiempo limitado de expiración para invalidarla en caso la misma llegue a ser comprometida.
Notas: La integración directa al API conlleva un grado más alto de complejidad pues requiere de hacer la implementación completa de la autenticación y manejo de recursos REST
SDK para API REST: – https://url_pais/api/rest/
Descripción: El SDK es la herramienta para desarrolladores que provee acceso a los recursos REST de forma más simple.
Ventajas: Esta herramienta provee todas las funcionalidades del API REST sin necesidad de tener que trabajar con detalles más técnicos como la implementación del protocolo como tal, ni la autenticación. Está disponible como software tipo “open source” (o código abierto), lo cual permite flexibilidad en su utilización y contribución al momento de la resolución de problemas.
Notas: El SDK se encuentra disponible para las plataformas: .NET, PHP y JAVA
| Tipo SDK | Direccion |
|---|---|
| Java | SDK-JAVA |
| PHP | SDK-PHP |
| .NET | SDK-.NET |
API HTTP:
Descripción: Se pone a disposición del usuario una herramienta de conexión utilizando el protocolo HTTP.
Ventajas: Esta herramienta permite integrar sistemas cerrados que ya soportan una interfaz SMS mediante el uso de un URL predefinido. La autenticación puede darse de 2 formas: ya sea por configuración de direcciones IP fijas o utilizando el API KEY. Esta herramienta también permite el envío de mensajes a contactos y grupos.
Notas: La herramienta no permite la administración de grupos y contactos y tampoco brinda acceso a la generación de reportes.
La documentación para cada tipo de conexión se encuentra disponible en el área descrita en la sección de DESCARGA DE RECURSOS, incluida al final del presente documento – numeral 8
2. Códigos de respuesta de plataforma
Para cada petición que sea ejecutada a la plataforma de conexión, se devolverá una respuesta de forma inmediata como retroalimentación del sistema para determinar si la misma fue exitosa o si existió algún error en su ejecución. El documento conteniendo el detalle de los códigos de respuesta, debe estar adjunto en el correo por el cual recibió esta guía, de lo contrario le sugerimos solicitarlo a su ejecutivo de ventas.
3. Horarios de envío
El horario habilitado para el envío de mensajes es de 6:00 a 19:30 horas. Si se desea enviar mensajes en horarios distintos debe elaborarse la solicitud por medio de su ejecutivo de ventas.
4. Políticas Anti-SPAM
Claro Notifícame SMS cuenta con altos estándares para el manejo de mensajes y aplica reglas de envío para asegurar que los destinatarios no se vean afectados por mensajes no deseados.
Para el efecto se maneja una “ventana de seguridad – 2hrs.” para elaborar el bloqueo de textos iguales a un mismo destinatario. El parámetro “ID” permite hacer override (corrección) de la ventana de bloqueo. Éste es un parámetro de manejo interno tipo varchar. Si desea conocer más al respecto le sugerimos consultar la documentación correspondiente para cada API donde obtendrá mayor detalle.
5. Longitud del Mensaje de Texto
Los mensajes de texto enviados por la herramienta Claro Notifícame SMS poseen una longitud fija de 160 caracteres, por lo que debe de tomar en cuenta lo siguiente, antes de realizar los cálculos para su aplicación.
A. El nombre corto (o Short_name) está incluido dentro de los 160 caracteres del mensaje, por lo que se debe descontar del total de caracteres los símbolos “; “ (dos puntos y espacio) que serán agregados automáticamente por la plataforma. CADA BLOQUE DE 160 CARACTERES CONSTITUYE UN MENSAJE A DESCONTAR DE SU PAQUETE CONTRATADO.
B. Los caracteres especiales (tales como tildes y otros signos de puntuación) ocupan más de un carácter, por lo que se recomienda no utilizar los mismos, ya que no todos los equipos móviles pueden desplegarlos de forma correcta.
C. La recomendación general, es mantener el mensaje con una longitud de 160 caracteres, ya que el equipo móvil destino es quien decidirá como mostrar el mensaje, en base a las características propias del mismo. Por ejemplo, los teléfonos de gama baja, segmentarán el mensaje en bloques de 160 caracteres para poder desplegarlos en pantalla; Los smart phones y teléfonos de gama media, mostraran los mensajes como una conversación, uniendo los distintos bloques.
6. Contenido de los mensajes
Se recomienda como regla de orden obligatorio que todo el contenido de los mensajes sea apegado a las regulaciones de su país y las condiciones contractuales del servicio. Todo contenido manejado a través de la herramienta y las consecuencias de su envío es responsabilidad del contratante del servicio.
7. Para alto tráfico de mensajes
Si se tiene la necesidad de una alta demanda o un tráfico mayor a 150,000 mensajes diarios, ole sugerimos ponerse en contacto con nuestro cuerpo técnico o directamente con su ejecutivo de ventas, para asesorarle en la conexión mediante múltiples hilos.
8. DESCARGA DE RECURSOS
A continuación se presenta la guía de recursos de acuerdo a su país. En ella podrá descargar la guía de conexión correspondiente al tipo de conexión que desea implementar (para ello debe contar con credenciales de administrador de su equipo):
| Pais | Dirección |
|---|---|
| GUATEMALA: | https://notificame.claro.com.gt/help |
| COSTA RICA: | https://notificame.claro.cr/help |
| EL SALVADOR: | https://notificame.claro.com.sv/help |
| HONDURAS: | https://notificame.claro.com.hn/help |
| NICARAGUA: | https://notificame.claro.com.ni/help |