API Vérification envoi de fichier

API envoi de fichier

L'API d'envoi de fichiers Captain Verify est la solution idéale pour les entreprises et les développeurs qui cherchent à optimiser leurs campagnes marketing et à améliorer la qualité de leur base de données. En intégrant cette API à vos outils existants, vous pourrez tirer pleinement parti des fonctionnalités de vérification avancées de Captain Verify, tout en bénéficiant d'un gain de temps et d'une meilleure productivité. Grâce à notre API, vous pouvez envoyer des fichiers (CSV, TXT) contenant les adresses email ou numéros mobiles à vérifier directement depuis votre application ou plateforme, sans avoir à passer par le dashboard. Notre infrastructure assure un traitement rapide et sécurisé de vos fichiers.

Clé API

Un compte est nécessaire pour générer la clé pour l'API, c'est ce qui vous donnera accès au service.

Limites de l'API

L'API est limitée à un 1 fichier par vérification.
Vous pouvez mettre jusqu'à 1 million de lignes par fichier email et 100 000 lignes par fichier numéros mobile. (20Mo max)
Assurez-vous que votre application ne dépasse pas ces limites.

Lister les fichiers

Pour récupérer la liste des fichiers et les status :

curl -X GET "https://api.captainverify.com/file/?apikey=APIKEY"

                        [{
"id":"21446",
"type":"email",
"name":"file1.txt",
"status":"done"
},{
"id":"21218",
"type":"mobile",
"name":"file2.txt",
"status":"ready"
}]
                        
                    

Status	Descriptions
file validation	Le fichier est en cour d'importation et de validation vers Captain Verify
ready	Le fichier est prêt pour la vérification
invalid	Le fichier n'est pas valide
processing	Le fichier est en cour de vérification
done	La vérification est terminé, Le fichier peut être téléchargé

Lancer une vérification

Pour lancer une vérification d'un fichier "ready" :

curl -X PUT "https://api.captainverify.com/file/21218?apikey=APIKEY"

⚠️ Le fichier doit être dans le status "ready".
"21218" est un exemple et il doit être remplacé par l'ID de votre fichier.

Réponses	Descriptions
success	[ 'status' => 'file #21218' sent for mobile validation' ]
not enough credits	[ 'error' => 'not enough credit' ]

Envoyer un fichier

Pour envoyer un fichier (TXT,CSV) :

Pour un fichier email

curl -X POST -F file=@file1.txt "https://api.captainverify.com/file/email?apikey=APIKEY"

file1.txt est le nom du fichier en local.

Pour un fichier mobile

curl -X POST -F file=@file2.txt "https://api.captainverify.com/file/hlr?apikey=APIKEY"

file2.txt est le nom du fichier en local.

Réponses	Descriptions
success response	[ 'status' => 'file file2.txt received' ]

Supprimer un fichier

Pour supprimer un fichier :

curl -X DELETE "https://api.captainverify.com/file/21218?apikey=APIKEY"

21218 est un exemple et il doit être remplacé par l'ID de votre fichier que vous voulez supprimer.
⚠️ Le status du fichier doit être: ready, invalid, done pour être supprimé.

Télécharger les résultats d'une vérification

Pour télécharger les résultats d'une vérification, vous avez 3 fichiers disponibles : all, ok et marketing* (plus d'informations dans la documentation). 2 formats de fichiers sont disponibles : CSV ou XLSX.

curl -X GET --output ok.csv "https://api.captainverify.com/file/21218/ok?apikey=APIKEY&ext=xlsx"

21218 est un exemple et il doit être remplacé par l'ID de votre fichier.
&ext=xlsx est le format de fichier par default, vous pouvez le remplacer par &ext=csv pour changer le format en CSV.

*Le fichier marketing est uniquement disponible pour les nouveaux fichiers vérifiés.

Erreurs

En cas d'erreur :

Réponses	Descriptions
error response	[ 'error' => ‘xxxxxxxxxxx’ ]