<aside> 🔗 Url para usar el servicio: https://masivlinks.masivapp.com/shorter
</aside>
Este endpoint sirve tanto para crear una sola URL como para crear múltiples URLs, en caso de que se quieran crear múltiples URLs solo es necesario agregar cada URL a agregar dentro del parámetro UrlRequest.
Se pueden crear un máximo de 1500 URLs dentro de una misma petición. Si el uso del producto es para crear múltiples URLs pertenecientes a una misma campaña(delivery) recomendamos realizar todas las generaciones por lotes, de esta manera el consumo del producto es óptimo.
Parámetro | Descripción | Requerido |
---|---|---|
IdClient | Tipo de dato: Entero. | |
Id del cliente que realiza la generación | ✅ | |
IdCampaign | Tipo de dato: Entero. | |
Id de la campaña a la que pertenece la generación | ✅ | |
IdProduct | Tipo de dato: String. | |
Id del producto desde el cual se realiza el consumo. Mapeo IdProduct: | ||
Valor por defecto: ‘links’ | ✅ | |
IdDelivery | Tipo de dato: String. | |
Id del delivery al que pertenece la generación. | ||
Longitud máxima: 50 caracteres. | ||
⚠️ Si el producto desde el que se realiza la generación es Links, este id cambiará internamente | ✅ | |
UrlRequest | Tipo de dato: Array de Url . | |
Mínimo: 1 | ||
Máximo: 1500 | ✅ | |
CustomDomain | Tipo de dato: String. | |
Si se quiere que la(s) url(s) generada(s) tenga(n) un dominio diferente al default, ingresar el dominio. Dicho dominio debe de ser configurado con anterioridad dentro del producto Links, de lo contrario la(s) url(s) generada(s) fallará(n) si no se ha hecho el proceso: ‣ |
Si no se especifíca dicho dominio, la generación se realizará con el dominio por defecto de Links. Dicho dominio es universal para todos los clientes. ⚠️El dominio debe existir y estar configurado para el cliente
Valor por defecto: https://ma.sv
Longitud máxima: 50 carácteres. | ❌ |
| Metadata | Tipo de dato: Objecto Json.
Información general que será enviada por parte de Links a los webhooks configurados dentro de la información del evento de click. | ❌ |
| WebHooks | Tipo de dato: Array de strings.
Links notificará a cada uno de los webhooks cada evento de click de las urls generadas, dentro de la notificación se enviará información del evento de click y la metadata definida.
Longitud máxima de webhook: 1000 caracteres.
‣ | ❌ |
| ActiveDate | Tipo de dato: String.
Fecha de activación de la(s) url(s).
⚠️ Debe estar en UTC 0
Valor por defecto: fecha actual del request.
Formato: ‘YYYY-MM-DD HH:mm:ss’ | ❌ |
| DueDate | Tipo de dato: String.
Fecha de expiración de la(s) url(s).
⚠️ Debe estar en UTC 0
Valor por defecto: 3 meses.
Formato: ‘YYYY-MM-DD HH:mm:ss’ | ❌ |
| UrlType | Tipo de dato: Entero.
Tipo de url(s) permitidas: 0, 1 y 2
Valor por defecto: 0
Mapeo UrlType: | ❌ |
Parámetro | Descripción | Requerido |
---|---|---|
Url | Tipo de dato: String. | |
****Url a acortar | ||
Longitud máxima: 1000 carácteres | ✅ | |
Name | Tipo de dato: String. | |
Nombre de la url. | ||
Longitud máxima: 150 caracteres. | ❌ | |
Preview | Url Preview | ❌ |
Recipient | Tipo de dato: String. | |
Destinatario de la url. Este dato permite individualizar la URL creada para posterior uso. | ||
Longitud máxima: 100 caracteres. | ❌ | |
Metadata | Tipo de dato: Objeto Json. | |
Información que se quiere sea propia de la url generada y que será enviada por parte de Links a los webhooks configurados dentro de la información del evento de click. | ❌ |
Parámetro | Descripción | Requerido |
---|---|---|
Title | Tipo de dato: String. | |
Título del preview | ||
Longitud máxima: 255 caracteres. | ❌ | |
Description | Tipo de dato: String. | |
Descripción del preview | ||
Longitud máxima: 255 caracteres. | ❌ | |
UrlImage | Tipo de dato: String. | |
Url desde la cual se va a referenciar la imagen que aparece en el preview de la url generada. Dicha url debe ser de fácil acceso para evitar errores tanto en la redirección como en la visualización del preview. | ❌ | |
KeyImage | Tipo de dato: String. | |
Llave para acceder a la imagen del preview desde los archivos internos de Links. Usar si se ha generado alguna url desde el Front de Links. | ❌ |
<aside> 💡 ¿Qué es una previsualización de URL?, a continuación se describe al detalle todo respecto a la previsualización de URL dentro de las comunicaciones y/o canales destinados.
</aside>
Product / Cell | ProductId |
---|---|
SMS | sms |
Automation | automation |
Sherlock | sherlock |
File Builder | filebuilder |
Integrations | vertical |
File Reader | filereader |
Transactional Hub | hub |
Shield | shield |
Links | links |
Ocean | ocean |
TruSense | trusense |
SmsApi | smsapi |
SmsCampaign | smscampaign |
Type | Url Type | Description |
---|---|---|
0 | Unique | Una url de destino, una url acortada, un solo destinatario |
1 | Specific | Una url de destino, multiples urls acortadas, multiples destinatarios |
2 | Custom (Personalized) | Multiples urls de destino, multiples urls acortadas, multiples destinatarios |
Para productos diferentes a Links este será el tipo por defecto | ||
3 | QR | Una url de destino, una url acortada, un solo destinatario. Se genera un código QR como respuesta. |
curl --location '<https://masivlinks.masivapp.com/shorter>'
--header 'Authorization: <YourAuthToken>'
--header 'Content-Type: application/json' \\
--data '{
"idClient": 1,
"idCampaign": 111,
"idProduct": "links",
"idDelivery": "Prueba",
"UrlRequest":[
{
"name": "url name",
"url": "<https://www.google.com/>",
"Preview":{
"Title":"Preview Title",
"Description":"Preview Description",
"UrlImage":"<https://image-url.com>"
"KeyImage": "image-location"
}
}
],
"UrlType":0,
"customDomain": "<https://custom.domain>",
"ActiveDate": "2023-09-12 23:59:59",
"DueDate": "2024-09-12 23:59:59",
"metadata": {
"info": "example info",
"metadataAdditionalInfo"{
"information": "example info inside metadata"
}
}
"webhooks": [
"<https://webhook-to-notify.com>"
]
}'
Field | Description |
---|---|
Code | Entero con el Status Code de la petición |
Message | String con un mensaje que especifica el resultado de la petición. |
Errors | Lista con los errores que se ocurrieron en la petición. Respuesta De Error |
Data | Array de urls generadas. Respuesta De Éxito |