API zur Verifizierung des Dateiversands

API für den Dateiversand

Die API für den Dateiversand von Captain Verify ist ideal für Unternehmen und Entwickler, die ihre Marketingkampagnen optimieren und die Qualität ihrer Datenbanken nachhaltig verbessern möchten. Indem Sie unsere API in Ihre bestehenden Apps und Anwendungen integrieren, können Sie die hochentwickelten Verifizierungsfunktionen von Captain Verify voll ausschöpfen und zeitsparend Ihre Produktivität maximieren. Mithilfe der API können Sie Ihre Dateien (CSV, TXT) mit den zu verifizierenden E-Mail-Adressen oder Handynummern direkt über Ihre Anwendung oder Plattform hochladen. Unsere Infrastruktur gewährleistet Ihnen die schnelle und sichere Verarbeitung Ihrer Daten.

API-Schlüssel

Zum Generieren des API-Schlüssels ist ein Benutzerkonto erforderlich.

API – Nutzungslimits

Die API ist für eine 1 Datei pro Verifizierung ausgelegt.
Eine Datei mit E-Mail-Adressen darf maximal 1 Million Zeilen und eine Datei mit Handynummern maximal 100.000 Zeilen enthalten (max. 20 MB).
Bitte stellen Sie bei der Integration der API sicher, dass Ihre Anwendung die Anforderungen erfüllt.

Dateien hochladen

So rufen Sie die Dateiliste und die zugehörigen Status ab:

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	Beschreibungen
file validation	Die Datei wird importiert und von Captain Verify validiert
ready	Die Datei ist bereit für die Verifizierung
invalid	Die Datei ist ungültig
processing	Die Datei wird verifiziert
done	Die Verifizierung ist abgeschlossen und die Datei steht zum Download bereit

Verifizierung einleiten

So leiten Sie die Verifizierung einer Datei mit dem Status „ready“ ein:

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

⚠️ Die Datei muss im Status „ready“ vorliegen.
Bitte ersetzen Sie das Beispiel „21218“ durch Ihre Dateikennung.

Antwort	Beschreibung
success	[ 'status' => 'file #21218' sent for mobile validation' ]
not enough credits	[ 'error' => 'not enough credit' ]

Datei senden

So versenden Sie eine Datei (im Format TXT oder CSV):

Datei mit E-Mail-Adressen

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

file1.txt: Name der gespeicherten Datei.

Datei mit Handynummern

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

file2.txt: Name der gespeicherten Datei.

Antwort	Beschreibung
success response	[ 'status' => 'file file2.txt received' ]

Datei löschen

So löschen Sie eine Datei:

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

Bitte ersetzen Sie das Beispiel „21218“ durch die Kennung der zu löschenden Datei.
⚠️ Um gelöscht werden zu können, muss die Datei in einem der folgenden Status vorliegen: ready, invalid, done.

Verifizierungsergebnisse herunterladen

Sie können die Ergebnisse einer Verifizierung in drei verschiedenen Dateitypen herunterladen: all, ok und marketing* (mehr dazu in der Dokumentation). Es stehen 2 Dateiformate zur Verfügung: CSV oder XLSX.

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

Bitte ersetzen Sie das Beispiel „21218“ durch Ihre Dateikennung.
Standardmäßig wir Ihre Datei im XLSX-Format bereitgestellt ((&ext=xlsx)). Sie können die Endung durch &ext=csv ersetzen, um ein CSV-Format zu erhalten.

* „marketing“ ist nur für neu verifizierte Dateien verfügbar.

Fehler

So gehen Sie bei Fehlermeldungen vor:

Antwort	Beschreibung
error response	[ 'error' => ‘xxxxxxxxxxx’ ]