Utilisez notre API !
En plus d’une application web, vous pouvez connecter vos systèmes (sites web, outils internes…) à Shakelist pour assurer une vérification de vos données en temps réel.
Qu’est-ce que l’API Shakelist permet de faire ?
Connectez vos systèmes à Shakelist
Bénéficiez de toute la puissance de Shakelist dans vos applications et oubliez les e-mails invalides !
Vérifiez en live
Connectez vos systèmes CRM / formulaires à Shakelist pour identifier, en direct, les erreurs de saisies !
Actualisez vos données
Vérifiez automatiquement vos listes d’adresses pour détecter, en proactif, tout changement sur un de vos destinataires.
Combien ça coute ?
L’accès à l’API Shakelist est gratuit !
Pour l’activer, rendez-vous simplement dans votre compte et générez une clé API.
Vous avez besoin d’aide ? Contactez le support !
Fonctions disponibles
Informations sur votre compte
account.php
Informations sur le compte
Paramètre obligatoire :
apikey
Votre clé d’API générée dans votre compte Shakelist.
Résultat :
JSON contenant les informations sur le compte.
Exemple d’appel :
https://app.shakelist.io/api/1.0/account.php?apikey={YOUR_API_KEY}
{
« APIKey »: « {YOUR_API_KEY} »,
« Credit »: 952445
}
Vérification unitaire
La vérification unitaire permet une vérification synchrone et rapide d’une adresse e-mail (et une seule).
Attention : la vérification peut prendre plusieurs secondes pendant lesquelles vous devez attendre.
Nous vous recommandons d’utiliser plutôt la vérification en liste car celle-ci se fait de manière asynchrone (voir plus bas).
check.php
Vérification synchrone
d’une adresse unique
Paramètres obligatoires :
apikey
Votre clé d’API générée dans votre compte Shakelist.
email
Adresse e-mail à valider (une seule dans ce mode).
Résultat :
JSON contenant le résultat du test.
Exemple d’appel :
https://app.shakelist.io/api/1.0/check.php?apikey={YOUR_API_KEY}&email=invalid@example.com
{
« testId »: « 443306 »,
« email »: « invalid@shakelist.io »,
« domain »: « shakelist.io »,
« result »: « KO »,
« resultDetail »: « ERR_DOESNOTEXIST »,
« resultMailsystem »: « Postfix »,
« isFormatValid »: 1,
« isDisposable »: 0,
« isFreemail »: 0,
« isRobot »: 0,
« isRisky »: 0,
« suggestion »: null
}
Vérification de listes
La vérification de liste permet une analyse plus poussée et ne nécessite pas que vous attendiez le résultat de la vérification dans la suite de l’appel.
Cette vérification fonctionne en mode asynchrone comme expliqué ci-dessous :
1 - Uploadez les adresses
Utilisez « list/add.php » pour ajouter vos adresses dans Shakelist. Un ID de test vous est retourné.
2 - Suivez la progression
Grâce à votre ID de test, vous interrogez régulièrement « list/status.php » pour suivre la progression du traitement.
3 - Récupérez les résultats
Une fois le traitement terminé, « list/status.php » vous donnera le résultat de votre analyse.
list/add.php
Ajout d’une liste d’adresses à traiter
Paramètres :
apikey
Votre clé d’API générée dans votre compte Shakelist.
emails
Adresses e-mail à valider séparées par des points virgules « ; ».
Chaque appel peut contenir jusqu’à 1000 adresses e-mails.
Les adresses peuvent être passées en POST/GET.
greylist (optionnel)
Passez ce paramètre à 1 pour analyser les greylist (attention, ce mode peut rendre l’analyse beaucoup plus longue !).
Résultat :
JSON contenant le nombre de crédits consommés et l’identifiant du test.
Exemple d’appel :
https://app.shakelist.io/api/1.0/list/add.php?apikey={YOUR_API_KEY}&emails=invalid@shakelist.io;ok@shakelist.io;badformatemail@1{
"nbMails": 3,
"id": "Aa023c3fe38"
}list/status.php
Suivre le traitement du fichier et obtenir les résultats
Paramètres :
apikey
Votre clé d’API générée dans votre compte Shakelist.
id
Identifiant du test pour lequel vous souhaitez les informations.
Résultat :
JSON en deux parties :
- « stats » : donne les informations sur l’avancement du traitement.
- « results » : présent uniquement si le traitement est terminé, donne le détail du résultat des tests.
Exemple d’appel :
https://app.shakelist.io/api/1.0/list/status.php?apikey={YOUR_API_KEY}&id=Aa023c3fe38Durant le traitement :
{
"stats": {
"idList": "Aa023c3fe38",
"status": "PENDING",
"emailCount": 3,
"stats": {
"PENDING": 2,
"OK": 1
}
}
}Traitement terminé :
{
« stats »: {
« idList »: « Aa023c3fe38 »,
« status »: « DONE »,
« emailCount »: 3,
« stats »: {
« KO »: 2,
« OK »: 1
}
},
« results »: [
{
« email »: « invalid@shakelist.io »,
« id »: 1,
« idList »: « Aa023c3fe0e438 »,
« Domain »: « shakelist.io »,
« IsFormatValid »: 1,
« IsDisposable »: 0,
« IsFreemail »: 0,
« IsRole »: 0,
« IsRisky »: 0,
« IsRobot »: 0,
« Suggestion »: null,
« Result »: « KO »,
« ResultDetail »: « ERR_DOESNOTEXIST »,
« ResultMailSystem »: « Postfix »,
« idJob »: 443307
},
{
« email »: « ok@shakelist.io »,
« id »: 2,
« idList »: « Aa023c3fe0e438 »,
« Domain »: « shakelist.io »,
« IsFormatValid »: 1,
« IsDisposable »: 0,
« IsFreemail »: 0,
« IsRole »: 0,
« IsRisky »: 0,
« IsRobot »: 0,
« Suggestion »: null,
« Result »: « OK »,
« ResultDetail »: « OK »,
« ResultMailSystem »: « Postfix »,
« idJob »: 443308
},
{
« email »: « badformatemail@1 »,
« id »: 3,
« idList »: « Aa023c3fe0e438 »,
« Domain »: « 1 »,
« IsFormatValid »: 0,
« IsDisposable »: 0,
« IsFreemail »: 0,
« IsRole »: 0,
« IsRisky »: 0,
« IsRobot »: 0,
« Suggestion »: « »,
« Result »: « KO »,
« ResultDetail »: « ERR_INVALID_FORMAT »,
« ResultMailSystem »: null,
« idJob »: 443309
}
]
}
Vous avez des questions ?
Que vous soyez déjà client ou non, contactez-nous !
Notre équipe se fera un plaisir de répondre à toutes vos questions.
