El poder de integrar
API de Info Masiva
+ HTTP API
+ Documentación
= Integración fácil
API Info Masiva
Nuestra nueva API te permitirá integrar Info Masiva con todas tus aplicaciones mediante simples llamadas a URLs, ofreciéndote innumerables funcionalidades, agrupadas por módulos para facilitar su utilización e implementación.
Podrás enviar tus campañas de email marketing; crear, modificar y eliminar contactos, listas de contactos y campañas; consultar estadísticas y reportes, y muchas más funcionalidades para que puedas integrarlo con tus aplicaciones.
Todas las URLs tienen la misma estructura: https://api.esmsv.com/v1/modulo/accion
modulo: Simboliza a un grupo de servicios. Por ejemplo: campaign, customfields, contacts, etc.
accion: Acción particular a realizar. Esta acción depende del módulo. Por ejemplo: create, edit, delete, etc.
Postman
Si utilizas Postman ponemos a disposición la colección de métodos para que importes en tu entorno.
Ver en PostmanSeteo de variables
Nuestra colección de métodos necesita de la parametrización de las siguientes variables de Postman para su correcto funcionamiento:
Nombre | Valor |
---|---|
url | https://api.esmsv.com |
token | I6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsIntyuHVlIjoiMm9y… |
Autenticación
Para utilizar la nueva API deberás contar con una Api key. Para esto deberás ingresar a tu cuenta, ir a Configuración > Clave Api y generar un nueva clave.Al utilizar los servicios deberá estar presente el método authorization en el header donde deberás enviar esta clave (token).
Ejemplo:
curl --location --request GET 'https://api.esmsv.com/v1/administrator/profile' --header 'Authorization: eyJpdiI6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsInZhbHVlIjoiMm9yaGZPYzZqNjVwL1haakw5SlovakNKcEZCeWpGaBcDEfGhIjklMNopqMD0iLCJtYWMiOiJhODVmNDgxZWUxYWoPu2Jktm1MjU0ZDhmNmUzMjA3NDliOGQwYWJkZWFlMjFkNDA4NmNiODRhMjYxIn0='
Aclaración: Si ya usabas la anterior Api y tenías creada una clave no podrás utilizar esa misma, sino que deberás crear una nueva.
Respuesta
Todas las respuestas tendrán dos secciones: status y code.
Adicionalmente, según el tipo de servicio, se agregarán otras secciones que se detallarán en cada uno de ellos.
Nombre | Descripción |
---|---|
status | Aquí saldrá valor “ok” cuando el proceso se ejecute correctamente y “error” cuando exista algún error. |
code | Aquí saldrá mensaje de éxito cuando el proceso se ejecute correctamente o un detalle cuando existan errores. |
Errores
Existen dos tipos de errores: de validación de datos de entrada (COD 422) y los particulares de cada servicio (COD 400). A continuación se detallan los errores de validación (COD 422) que son comunes a todos los servicios:
Código | Descripción |
---|---|
is_not_accepted | Valor no aceptado. |
invalid_url | URL inválida. |
invalid_date | Fecha incorrecta. |
invalid_alpha_format | El valor sólo debe contener letras. |
invalid_alpha_dash_format | El valor sólo debe contener letras, números, guiones y guiones bajos. |
invalid_alpha_num_format | El valor sólo debe contener letras y números. |
invalid_array_format | El Valor debe ser un array. |
attached | Este campo ya se adjuntó. |
before_date | El valor debe ser una fecha anterior. |
before_or_equal_date | El valor debe ser una fecha anterior o igual. |
invalid_between_elements | Cantidad de elementos inválido. |
invalid_between_size_file | Tamaño de archivo inválido. |
invalid_between_number | Valor inválido. |
invalid_between_characters | Cantidad de caracteres inválido. |
invalid_boolean | El valor debe ser true o false. |
invalid_value_confirmed | Valor confirmado inválido. |
invalid_date_format | Formato de fecha inválido. |
invalid_date_equal | Fecha incorrecta. |
invalid_value_different | El valor debe ser diferente. |
invalid_value_digits | Cantidad de digitos inválido. |
invalid_value_digits_between | Cantidad de digitos inválido. |
invalid_image_dimensions | Dimensiones de imagen inválidas. |
value_duplicate | Valor duplicado. |
invalid_email_format | El formato del email es incorrecto. |
invalid_velue_ends_with | El valor ingresado es incorrecto. |
not_exists | El campo es inválido. |
is_not_file | El campo debe ser un archivo. |
not_empty | El campo es obligatorio. |
invalid_gt_elements | Cantidad de elementos inválido. |
invalid_gt_size_file | Tamaño de archivo inválido. |
invalid_gt_numeric | Valor incorrecto. |
invalid_gt_characters | Cantidad de caracteres inválido. |
invalid_gte_elements | Cantidad de elementos inválido. |
invalid_gte_size_file | Tamaño del archivo inválido. |
invalid_gte_numeric | Valor inválido. |
invalid_gte_characters | Cantidad de caracteres inválido. |
invalid_image | El campo debe ser una imagen. |
invalid_value_in | Valor inválido. |
invalid_value_in_array | Valor inválido. |
invalid_value_integer | El campo debe ser un número entero. |
invalid_value_ip | El campo debe ser una dirección IP válida. |
invalid_ipv4_format | El campo debe ser una dirección IPv4 válida. |
invalid_ipv6_format | El campo debe ser una dirección IPv6 válida. |
invalid_json_format | El campo El campo debe ser una cadena JSON válida. |
invalid_lt_elements | Cantidad de elementos inválido. |
invalid_lt_size_file | Tamaño del archivo inválido. |
invalid_lt_numeric | Valor inválido. |
invalid_lt_characters | Cantidad de caracteres inválida. |
invalid_lte_elements | Cantidad de elementos inválido. |
invalid_lte_size_file | Tamaño del archivo inválido. |
invalid_lte_numeric | Valor inválido. |
invalid_lte_characters | Cantidad de caracteres inválido. |
invalid_max_elements | Cantidad de elementos inválido. |
invalid_max_size_file | Tamaño del archivo inválido. |
invalid_max_numeric | Valor inválido. |
invalid_max_characters | Cantidad de caracteres inválido. |
invalid_mimes | Formato de archivo inválido. |
invalid_mimetypes | Formato de archivo inválido. |
invalid_min_elements | Cantidad de elementos inválido. |
invalid_min_size_file | Tamaño de archivo inválido. |
invalid_min_numeric | Valor inválido. |
invalid_min_characters | Cantidad de caracteres inválido. |
multiple_of | Valor inválido. |
invalid_format | Formato de campo inválido. |
only_numeric | El campo debe ser numérico. |
invalid_password | Contraseña es incorrecta. |
is_not_present | El campo debe estar presente. |
prohibited | El campo está prohibido. |
prohibited_if | El campo está prohibido. |
prohibited_unless | El campo está prohibido. |
relatable | El campo no se puede asociar con este recurso. |
required | El campo es obligatorio. |
is_not_same_that | El campo deben coincidir. |
invalid_count_elements | Cantidad de elementos inválido. |
invalid_size_file | Tamaño de archivo inválido. |
invalid_size_number | Valor inválido. |
invalid_count_characters | Cantidad de caracteres inválido. |
invalid_value | Valor inválido. |
only_characters | El campo debe ser una cadena de caracteres. |
invalid_timezone | El campo debe ser una zona válida. |
is_used | El campo ya ha sido registrado. |
error_upload_file | Error al subir el archivo. |
invalid_url_format | El formato tipo url del campo es inválido. |
invalid_uuid_format | El campo debe ser un UUID válido. |