API Scoring API: статус файла

API скоринга filestatus возвращает статус обработки файла, отправленного с использованием API sendfile. Пожалуйста, обратитесь к примеру C # для деталей.

GET / V2 / SCORING / FILESTATUS

URL API: https://bulkapi.zerobounce.net/v2/scoring/filestatus

Параметры URL

  • ПАРАМЕТР
    Обязательный / Дополнительно
    Описание
  • api_key
    Обязательный
    Ваш ключ API, найденный в вашем аккаунте
  • file_id
    Обязательный
    Возвращенный идентификатор файла при вызове скоринга API sendfile

Если вы хотите вызвать API из своего браузера, чтобы протестировать его, ве, что вам нужно сделать, это заменить API-ключ на ваш ключ и идентификатор файла на возвращенный идентификатор файла из скоринга sendfile.

Примеры кода состояния файла

  • Visual Basic
  • C#
  • PHP
  • Ява
  • Питон
  • СВИФТ
  • Цель С
  • Android Java
      
Образец состояния файла в VB.net

Общественности Класс FileStatus
   Общественности Имущество success Как Логический
   Общественности Имущество file_id Как Строка
   Общественности Имущество file_name Как Строка
   Общественности Имущество upload_date Как Строка
   Общественности Имущество file_status Как Строка
   Общественности Имущество complete_percentage Как Строка
   Общественности Имущество return_url Как Строка
Конец Класс

Частный Общий Суб FileStatusAPITest()
   Тусклый apiKey Как Строка = "замени свой ключ api здесь"
   Тусклый fileID Как Строка = Msgstr "заменить на возвращенный идентификатор файла при вызове sendfile API"

   Пытаться
       Тусклый fileStatus Как FileStatus = FileStatusAsync(apiKey, fileID).Result
       Console.Напишите(JsonConvert.SerializeObject(fileStatus, Formatting.Indented))
   Поймать ex Как Exception
       Console.Напишите(ex.InnerException.Message)
   Конец Пытаться

   Console.ReadKey()
Конец Суб

Общественности Общий Async Функция FileStatusAsync(ByVal apiKey Как Строка, ByVal fileID Как Строка) Как Task(Из FileStatus)
   Если Строка.IsNullOrEmpty(apiKey) Затем Бросать Новый Exception(«Ошибка: требуется apiKey»)
   Если Строка.IsNullOrEmpty(fileID) Затем Бросать Новый Exception(«Ошибка: fileID требуется»)
   Тусклый uri Как Uri = Новый Uri($"https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key={apiKey}&file_id={fileID}")

   С помощью client = Новый HttpClient()
       С помощью request = Новый HttpRequestMessage(HttpMethod.получить, uri)
           С помощью response = Await client.SendAsync(request).ConfigureAwait(Ложь)
               Тусклый content = Await response.Content.ReadAsStringAsync()

               Если response.IsSuccessStatusCode = Ложь Затем
                   Тусклый ошибка Как Строка = $"StatusCode = {CInt(response.StatusCode)}, Content = {content}"
                   Бросать Новый Exception(ошибка)
               Конец Если

               Вернуть JsonConvert.DeserializeObject(Из FileStatus)(content)
           Конец С помощью
       Конец С помощью
   Конец С помощью
Конец Функция
   

// Пример состояния файла в C #

Общественности Класс Filestatus
{
   Общественности bool success { получить; задавать; }
   Общественности Строка file_id { получить; задавать; }
   Общественности Строка file_name { получить; задавать; }
   Общественности Строка upload_date { получить; задавать; }
   Общественности Строка file_status { получить; задавать; }
   Общественности Строка complete_percentage { получить; задавать; }
   Общественности Строка return_url { получить; задавать; }
}

Частный статический пустота Filestatusapitest()
{
   Строка apiKey = "замени свой ключ api здесь";
   Строка fileID = Msgstr "заменить на возвращенный идентификатор файла при вызове sendfile API";

   Пытаться
   {
       Filestatus fileStatus = Filestatusasync(apiKey, fileID).Result;
       Console.Напишите(JsonConvert.Serializeobject(fileStatus, Formatting.Indented));
   }
   Поймать (Исключение ex)
   {
       Console.Напишите(ex.InnerException.Message);
   }
   Console.ReadKey();
}

Общественности статический асинхронной Task<FileStatus> Filestatusasync(Строка apiKey, Строка fileID)
{
   Если (Строка.Isnullorempty(apiKey))
       Бросать Новый Исключение(«Ошибка: требуется apiKey»);
   Если (Строка.Isnullorempty(fileID))
       Бросать Новый Исключение(«Ошибка: fileID требуется»);

   URI uri = Новый URI($"https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key={apiKey}&file_id={fileID}");

   С помощью (вар client = Новый HttpClient())
   С помощью (вар request = Новый Httprequestmessage(HttpMethod.Get, uri))
   С помощью (вар response = ждите client.SendAsync(request).Configureawait(Ложь))
   {
       вар content = ждите response.Content.Readasstringasync();

       Если (response.IsSuccessStatusCode == Ложь)
       {
           вар error = $"StatusCode = {(int) response.StatusCode}, Content = {content}";
           Бросать Новый Исключение(error);
       }

       Вернуть JsonConvert.Deserializeobject<Filestatus>(content);
   }
}
   

   <?php

   $ завиток = curl_init();
   
   curl_setopt_array($ завиток, массив(
     CURLOPT_URL => "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours",
     CURLOPT_RETURNTRANSFER => Правда,
     CURLOPT_ENCODING => "",
     CURLOPT_MAXREDIRS => 10,
     CURLOPT_TIMEOUT => 30,
     CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
     CURLOPT_CUSTOMREQUEST => "ПОЛУЧИТЬ",
     CURLOPT_POSTFIELDS => "",
     CURLOPT_HTTPHEADER => массив(
       "Почтальон-токен: 91504 cea-f92f- 46 b0- 97 a4- 338167072887",
       "контроль кеша: нет кеша"
     ),
   ));
   
   $ ответ = curl_exec($ завиток);
   $ err = curl_error($ завиток);
   
   curl_close($ завиток);
   
   Если ($ err) {
     эхо "Ошибка cURL #:" . $ err;
   } еще {
     эхо $ ответ;
   }
   ?>
   

   Okhttpclient client = Новый Okhttpclient();

   Запрос request = Новый Запрос.СТРОИТЕЛЬ()
     .url("https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours")
     .получить()
     .AddHeader(«кэш-контроль», «нет кэша»)
     .AddHeader(«Почтальон-Токен», "7 fffd7a4-b2fd- 4 e8b-ac85- 4099411 f27ce")
     .строить();
   
   ОТВЕТ response = client.новый вызов(request).выполнять();
   

   импортировать http.client

   conn = http.client.HTTPConnection("bulkapi, zerobounce, чистый")
   
   payload = ""
   
   headers = {
       «кэш-контроль»: «нет кэша»,
       «Почтальон-Токен»: "caa917fe- 45 ce- 45 ae- 9456-2 b039b999dcb"
       }
   
   conn.request("ПОЛУЧИТЬ", "v2, filestatus", payload, headers)
   
   res = conn.getresponse()
   data = res.read()
   
   распечатать(data.decode("utf- 8"))
   
   

   // Пожалуйста, выберите язык VB или C # для File Status Sampleimport Foundation

   позволяь headers = [
     «кэш-контроль»: «нет кэша»,
     «Почтальон-Токен»: "4 f1b92e2- 034 f- 4 fa0- 94 d9-b097d768668a"
   ]
   
   позволяь request = Nsmutableurlrequest(url: NSURL(string: "https://bulkapi.zerobounce.net/v2/scoring/filestatus?api_key=replacewithyours&file_id=replacewithyours")! Как url,
                                           cachePolicy: .useProtocolCachePolicy,
                                       timeoutInterval: 10.0)
   request.httpMethod = "ПОЛУЧИТЬ"
   request.allHTTPHeaderFields = headers
   
   позволяь session = Urlsession.shared
   позволяь dataTask = session.datatask(with: request Как URLRequest, completionHandler: { (data, response, error) -> пустота в
     Если (error != нль) {
       распечатать(error)
     } еще {
       позволяь httpResponse = response Как? Httpurlresponse
       распечатать(httpResponse)
     }
   })
   
   dataTask.продолжить()
   

   #импортировать <Foundation/Foundation.h>

   NSDictionary *headers = @{ @ «кэш-контроль»: @ «нет кэша»,
                              @ «Почтальон-Токен»: @"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:@"ПОЛУЧИТЬ"];
   [request setAllHTTPHeaderFields:headers];
   
   NSURLSession *session = [NSURLSession sharedSession];
   NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                               completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                   Если (error) {
                                                       NSLog(@"%@", error);
                                                   } еще {
                                                       NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                       NSLog(@"%@", httpResponse);
                                                   }
                                               }];
   [dataTask resume];
   

// N/A
   

Ответ конечной точки

Успешный ответ

      
{
 «успех»: Правда,
 "file_id": "aaaaaaaa-zzzz-хххх-yyyy- 5003727 fffff",
 "имя файла": "Ваш файл name.csv",
 "дата загрузки": "10/20/2018 4:35: 58 PM",
 "file_status": «Полный»,
 "complete_percentage": "100%",
 "return_url": «Ваш обратный URL, если он указан при вызове sendfile API»
}
   

Овет об ошибке


   {      
     «успех»: Ложь,
     "сообщение": "Сообщения об ошибках"
   }