AI Scoring API: Dateistatus
Die Scoring Filestatus API gibt den Dateiverarbeitungsstatus für die Datei zurück, die mithilfe der Sendfile-API gesendet wurde. Weitere Informationen finden Sie im C # -Beispiel.
GET / V2 / SCORING / FILESTATUS
API-URL: https://bulkapi.zerobounce.net/v2/scoring/filestatus
URL-Parameter
- ParameterErforderlich / OptionalBeschreibung
- api-schlüsselErforderlichIhr API-Schlüssel befindet sich in Ihrem Konto
- file_idErforderlichDie zurückgegebene Datei-ID beim Aufrufen der Scoring-Sendfile-API
Wenn Sie die API von Ihrem Browser aus aufrufen möchten, um sie zu testen, müssen Sie lediglich den API-SCHLÜSSEL durch Ihren Schlüssel und die DATEI-ID durch die vom Scoring sendfile zurückgegebene Datei-ID ersetzen
Beispiele für Dateistatuscodes
'Dateistatusbeispiel in VB.net
Öffentlichkeit Klasse FileStatus
Öffentlichkeit Eigentum success WIE Boolesch
Öffentlichkeit Eigentum file_id WIE Zeichenfolge
Öffentlichkeit Eigentum file_name WIE Zeichenfolge
Öffentlichkeit Eigentum upload_date WIE Zeichenfolge
Öffentlichkeit Eigentum file_status WIE Zeichenfolge
Öffentlichkeit Eigentum complete_percentage WIE Zeichenfolge
Öffentlichkeit Eigentum return_url WIE Zeichenfolge
ENDE Klasse
Privat Freigegeben Sub FileStatusAPITest()
Dim apiKey WIE Zeichenfolge = "hier durch deinen api-schlüssel ersetzen"
Dim fileID WIE Zeichenfolge = "Beim Aufrufen der sendfile-API durch die zurückgegebene Datei-ID ersetzen"
VERSUCHEN
Dim fileStatus WIE FileStatus = FileStatusAsync(apiKey, fileID).Result
Console.Schreiben(JsonConvert.SerializeObject(fileStatus, Formatting.Indented))
Fang ex WIE Exception
Console.Schreiben(ex.InnerException.Message)
ENDE VERSUCHEN
Console.ReadKey()
ENDE Sub
Öffentlichkeit Freigegeben Async Funktion FileStatusAsync(Byval apiKey WIE Zeichenfolge, Byval fileID WIE Zeichenfolge) WIE Task(Von FileStatus)
OB Zeichenfolge.IsNullOrEmpty(apiKey) Dann Werfen NEU Exception("Fehler: apiKey ist erforderlich")
OB Zeichenfolge.IsNullOrEmpty(fileID) Dann Werfen NEU Exception("Fehler: Datei-ID erforderlich")
Dim uri WIE Uri = NEU Uri($"https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key={apiKey}&file_id={fileID}")
Verwenden client = NEU HttpClient()
Verwenden request = NEU HttpRequestMessage(HttpMethod.bekommen, uri)
Verwenden response = Await client.SendAsync(request).ConfigureAwait(Falsch)
Dim content = Await response.Content.ReadAsStringAsync()
OB response.IsSuccessStatusCode = Falsch Dann
Dim error WIE Zeichenfolge = $"StatusCode = {Cint(response.StatusCode)}, Content = {content}"
Werfen NEU Exception(error)
ENDE OB
Rückkehr JsonConvert.DeserializeObject(Von FileStatus)(content)
ENDE Verwenden
ENDE Verwenden
ENDE Verwenden
ENDE Funktion
// Beispiel für den Dateistatus in C #
Öffentlichkeit Klasse Filestatus
{
Öffentlichkeit bool success { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge file_id { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge file_name { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge upload_date { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge file_status { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge complete_percentage { bekommen; einstellen; }
Öffentlichkeit Zeichenfolge return_url { bekommen; einstellen; }
}
Privat statisch leere Filestatusapitest()
{
Zeichenfolge apiKey = "hier durch deinen api-schlüssel ersetzen";
Zeichenfolge fileID = "Beim Aufrufen der sendfile-API durch die zurückgegebene Datei-ID ersetzen";
VERSUCHEN
{
Filestatus fileStatus = Filestatusasync(apiKey, fileID).Result;
Console.Schreiben(JsonConvert.Serializeobject(fileStatus, Formatting.Indented));
}
Fang (Ausnahme ex)
{
Console.Schreiben(ex.InnerException.Message);
}
Console.Schlüssel einlesen();
}
Öffentlichkeit statisch asynchron Task<FileStatus> Filestatusasync(Zeichenfolge apiKey, Zeichenfolge fileID)
{
OB (Zeichenfolge.Isnullorempty(apiKey))
Werfen NEU Ausnahme("Fehler: apiKey ist erforderlich");
OB (Zeichenfolge.Isnullorempty(fileID))
Werfen NEU Ausnahme("Fehler: Datei-ID erforderlich");
Uri uri = NEU Uri($"https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key={apiKey}&file_id={fileID}");
Verwenden (var client = NEU Httpclient())
Verwenden (var request = NEU Httprequestmessage(HttpMethod.Get, uri))
Verwenden (var response = erwarten client.Sendasync(request).Configurewawait(Falsch))
{
var content = erwarten response.Content.Readasstringasync();
OB (response.IsSuccessStatusCode == Falsch)
{
var error = $"StatusCode = {(int) response.StatusCode}, Content = {content}";
Werfen NEU Ausnahme(error);
}
Rückkehr JsonConvert.Objekt deserialisieren<Filestatus>(content);
}
}
<?php
$ curl = curl_init();
curl_setopt_array($ curl, array(
CURLOPT_URL => "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours",
CURLOPT_RETURNTRANSFER => Wahr,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "BEKOMMEN",
CURLOPT_POSTFIELDS => "",
CURLOPT_HTTPHEADER => array(
"Postman-Token: 91504 cea-f92f- 46 b0- 97 a4- 338167072887",
"cache-kontrolle: kein cache"
),
));
$ antwort = curl_exec($ curl);
$ err = curl_error($ curl);
curl_close($ curl);
OB ($ err) {
echo "Curl-Fehler #:" . $ err;
} sonst {
echo $ antwort;
}
?>
Okhttpclient client = NEU Okhttpclient();
Anfrage request = NEU Anfrage.Baumeister()
.url("https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours")
.bekommen()
.Addheader("cache-kontrolle", "kein cache")
.Addheader("Postbote-Token", 7 fffd7a4-b2fd- 4 e8b-ac85- 4099411 f27ce)
.bauen();
Antwort response = client.neuer Anruf(request).ausführen();
einführen http.client
conn = http.client.HTTPConnection("bulkapi, zerobounce, net")
payload = ""
headers = {
'cache-kontrolle': "kein cache",
"Postbote-Token": caa917fe- 45 ce- 45 ae- 9456-2 b039b999dcb
}
conn.request("BEKOMMEN", "v2, filestatus", payload, headers)
res = conn.getresponse()
data = res.read()
drucken(data.decode("utf- 8"))
// Bitte wählen Sie die VB- oder C # -Sprache für File Status Sampleimport Foundation
lassen headers = [
"cache-kontrolle": "kein cache",
"Postbote-Token": 4 f1b92e2- 034 f- 4 fa0- 94 d9-b097d768668a
]
lassen request = Nsmutableurlrequest(url: NSURL(string: "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours")! WIE url,
cachePolicy: .useProtocolCachePolicy,
timeoutInterval: 10.0)
request.httpMethod = "BEKOMMEN"
request.allHTTPHeaderFields = headers
lassen session = Urlsession.shared
lassen dataTask = session.Datenaufgabe(with: request WIE URL-Anfrage, completionHandler: { (data, response, error) -> leere im
OB (error != null) {
drucken(error)
} sonst {
lassen httpResponse = response WIE? Httpurlresponse
drucken(httpResponse)
}
})
dataTask.fortsetzen()
#einführen <Foundation/Foundation.h>
NSDictionary *headers = @{ @ "cache-kontrolle": @ "kein cache",
@ "Postman-Token": @"5e9c24ae-b577-4e33-8748-83f14e151ae9" };
NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours"]
cachePolicy:NSURLRequestUseProtocolCachePolicy
timeoutInterval:10.0];
[request setHTTPMethod:@"BEKOMMEN"];
[request setAllHTTPHeaderFields:headers];
NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
OB (error) {
Nslog(@"%@", error);
} sonst {
NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
Nslog(@"%@", httpResponse);
}
}];
[dataTask resume];
// N/A
Endpunktantwort
Erfolgreiche Antwort
{
"erfolg": Wahr,
"file_id": "aaaaaaaa-zzzz-xxxx-yyyy- 5003727 fffff",
"dateiname": "Ihr Dateiname.csv",
"datum des hochladens": "10/20/2018 4:35: 58 PM",
"file_status": "Komplett",
"complete_percentage": "100%",
"return_url": "Ihre Rückgabe-URL, falls beim Aufrufen der sendfile-API angegeben"
}
Fehlerantwort
{
"erfolg": Falsch,
"botschaft": "Fehlermeldungen"
}