API Raccourcisseur URL

Cette API permet de raccourcir vos URL pour vos campagnes afin de minimiser le nombre de caractères dans vos SMS.

Inscription

Pour demander un accès envoyez un mail à support@mtarget.fr. avec comme sujet de mail "Demande d'accès à l'API raccourcisseur d'URL" et en précisant vos coordonnées :

email du compte
nom
prénom
nom de la société
Siret
numéro de téléphone mobile

Une fois vos accès demandés, nous vous fournirons des identifiants afin d'accéder à notre outil en ligne et ainsi pouvoir générer vos URL et visualiser vos statistiques. Si vous avez la nécessité d'utiliser notre API, nous vous fournirons une clé qui vous permettra de vous connecter, et un nom de domaine court qui sera associé à vos URL raccourcis.

Raccourcir des URLs

Cette API permet de générer des URL courtes à partir de vos URL longues.

Lors de vos requêtes il est nécessaire d'envoyer la clé en header pour vous authentifier.

Pour raccourcir une URL il est nécessaire de renseigner 3 champs :

Le nom de la campagne dans laquelle les liens raccourcies seront générés
Un domaine 'court' qui a été configuré chez nous et que nous vous avons retournée
Un tableau des urls que vous souhaitez raccourcir

POST https://shortlink-api.mtarget.fr/shorten HEADERS

Content-Typeapplication/json

Type du contenu envoyé dans la requête

access-keyOFAFhdezhj645oiha78fFU78Z65F

Clé d'accès qui vous a été envoyée lors de votre inscription

BODY

  "campaign": {
    "name": "MyCampaignName",
    "createIfNotExist": false,
    "endDate": "2023-02-28"
},

Ce JSON est expliqué dans la partie suivante.

  "short_domain": "shtl.eu",

  "url": [
    {
        "long_url": "https:\/\/urllong.com\/"
    },
    {
        "long_url": "https:\/\/urllong.com\/"
    }
  ],

Raccourcir une URL

Informations importantes :

Les champs en gras dans la légende de la requête sont obligatoires.
Les champs en italique dans la légende de la requête sont facultatifs.
Si le champ createIfNotExist est à false ou non précisé, la campagne ne sera jamais créée si elle n'existe pas
Une fois la date de fin de campagne dépassée (endDate), tous les liens raccourcis créés pour celle-ci ne seront plus valides. Si quelqu'un utilise un scramble non valide, il sera redirigé vers une page 404.
Vous serez toujours capable de voir le nombre de hits total, mais vous n'aurez plus accès à la liste des urls courtes.

Exemple de requête :

            {
                "campaign": {
                    "name": "MonNomDeCampagne",
                    "createIfNotExist" : false,
                    "endDate": "2024-01-01"
                },
                "short_domain":"shtl.eu",
                "url": [
                    {"long_url":"https://urllong.com/"},
                    {"long_url":"https://urllong.com/"}
                ]
            }

campaign : Toutes les informations sur la campagne.
name : Nom de la campagne.
createIfNotExist : Si true et que la campagne n'est pas trouvée, elle est automatiquement créée. Valeur par défaut : false.
endDate : Date de fin de la campagne. Valeur par défaut : 6 mois après la date de création. Les statistiques détaillées sont conservées 6 mois après la date de fin de la campagne.
short_domain : Le domaine court configuré à utiliser pour raccourcir l'url.
url : Tableau de toutes les urls à raccourcir. Maximum de 500 urls.

Réponse :

            {
                "status": 0,
                "campaign": {
                    "name": "Test campaign",
                    "createIfNotExist": false,
                    "endDate": "2023-02-28"
                },
                "short_domain": "shtl.eu",
                "url": {
                    "success": [
                        {
                            "long_url": "https://urllong.com/",
                            "short_url": "http://shtl.eu/80zSPi"
                        },
                        {
                            "long_url": "https://urllong.com/",
                            "short_url": "http://shtl.eu/16F2W5"
                        }
                    ],
                    "error": []
                }
            }

status : État des retours
- 0 : Succès
- 1 : Succès partiel
- 2 : Erreur
campaign : Toutes les informations sur la campagne.
name : Nom de la campagne.
createIfNotExist : Si true et que la campagne n'est pas trouvée, elle est automatiquement créée. Valeur par défaut : false.
endDate : Date de fin de la campagne. Valeur par défaut : 6 mois après la date de création. Les statistiques détaillées sont conservées 6 mois après la date de fin de la campagne.
short_domain : Le domaine court configuré à utiliser pour raccourcir l'url.
success : Tableau de toutes les urls raccourcies.
error : Tableau de toutes les urls en erreur.