API invio di file tramite email e mobile
Il file Captain Verify che invia l'API è la soluzione ideale per aziende e sviluppatori che cercano di ottimizzare le loro campagne di marketing e migliorare la qualità del loro database. Integrando questa API nei tuoi strumenti esistenti, è possibile sfruttare completamente le caratteristiche di verifica avanzate di Captain Verify, godendo del tempo e una migliore produttività. Grazie alla nostra API, puoi inviare file (CSV, txt) contenenti indirizzi e-mail o numeri di cellulare da controllare direttamente dalla tua applicazione o piattaforma, senza dover passare attraverso la dashboard. La nostra infrastruttura garantisce un'elaborazione rapida e sicura dei tuoi file.
Chiave API
È necessario un account per generare la chiave per l'API, questo ti darà accesso al servizio.
Limiti API
L'API è limitata a un file 1 per verifica.
È possibile mettere fino a 1 milione di righe per file email e 100.000 righe per file di numeri di cellulare. (20mo max)
Assicurati che la tua applicazione non superi questi limiti.
Elenca i file
Per recuperare l'elenco dei file e lo stato:
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"
}]
Stato | Descriptions |
---|---|
file validation | Il file è nell'importazione e nella convalida per Captain Verify |
ready | Il file è pronto per la verifica |
invalid | Il file non è valido |
processing | Il file è nel cortile di verifica |
done | La verifica è completata, il file può essere scaricato |
Avvia un assegno
Per lanciare una verifica del file "ready":
curl -X PUT "https://api.captainverify.com/file/21218?apikey=APIKEY"
⚠️ Il file deve essere nello stato "ready".
"21218" è un esempio e deve essere sostituito dall'ID del tuo file.
Risposte | Descriptions |
---|---|
success | [ 'status' => 'file #21218' sent for mobile validation' ] |
not enough credits | [ 'error' => 'not enough credit' ] |
Invia un file
Per inviare un file (TXT, CSV):
Per un file emailcurl -X POST -F file=@file1.txt "https://api.captainverify.com/file/email?apikey=APIKEY"
file1.txt è il nome del file locale.
Per un file mobilecurl -X POST -F file=@file2.txt "https://api.captainverify.com/file/hlr?apikey=APIKEY"
file2.txt è il nome del file locale.
Risposte | Descriptions |
---|---|
success response | [ 'status' => 'file file2.txt received' ] |
Elimina un file
Per eliminare un file:
curl -X DELETE "https://api.captainverify.com/file/21218?apikey=APIKEY"
21218 è un esempio e deve essere sostituito dall'ID del tuo file che si desidera eliminare.
⚠️ Lo stato del file deve essere: ready, invalid, done, da eliminare.
Scarica i risultati di una verifica
Per scaricare i risultati di una verifica, sono disponibili 3 file : all, ok e marketing* (Maggiori informazioni nella documentazione). Sono disponibili 2 formati di file : CSV o XLSX.
curl -X GET --output ok.csv "https://api.captainverify.com/file/21218/ok?apikey=APIKEY&ext=xlsx"
21218 è un esempio e deve essere sostituito dall'ID del tuo file.
&ext=xlsx è il formato file per impostazione predefinita, è possibile sostituirlo con &ext=csv Per cambiare il formato CSV.
*Il file di marketing è disponibile solo per nuovi file verificati.
Errori
In caso di errore:
Risposte | Descriptions |
---|---|
error response | [ 'error' => ‘xxxxxxxxxxx’ ] |