Через API можно проверить как одну
заявку, так и пакет до 1000 заявок
При многократой попытке проверить
одну и туже заявку (набор заявок), будет заблокирована работа через API
Эл-т |
Тип |
По-умолчанию |
Условие |
Описание |
apiKey |
string |
|
|
API-КЛЮЧ |
ordersString |
string |
all |
int,int,int... НЕ ОБЯЗАТЕЛЬНО |
ПЕРЕЧЕТЬ ЗАЯВОК ЧЕРЕЗ ЗАПЯТУЮ. Если перечень отсутствует, то используется аргумент all, т.е. все заявки |
inWork |
bool |
false |
Если true, то возвращает только заказы, работа по которым еще продолжается НЕ ОБЯЗАТЕЛЬНО |
|
whereIsMyMoney |
bool |
false |
Если true, то возвращает информацию только по заявкам, деньги по которым еще не вернули НЕ ОБЯЗАТЕЛЬНО |
|
Ответ сервера API
Эл-т |
Тип |
По-умолчанию |
Условие |
Описание |
timestamp |
int |
|
|
Дата обработки Вашего запроса. Unixtime |
error |
bool |
|
|
Если имеется ошибка в запросе, при создании, то выдает true,
в противном случае false |
errorDescription |
string |
|
Если error==true |
Пояснение к причине ошибки |
ip |
string |
|
Выводится, если включен Режим разработки |
IP-адрес с которого пришел запрос |
in |
array |
|
Выводится, если включен Режим разработки |
Данные, которые вы передаете на сервер API |
out |
array |
|
Если error==true, отсутствует |
Данные с результатами запроса |
timestampEnd |
int |
|
|
Дата окончания обработки Вашего запроса. Unixtime |
Ответ сервера API. Элемент out
Эл-т |
Тип |
По-умолчанию |
Условие |
Описание |
id |
array |
|
|
Номер заявки |
Ответ сервера API. Элемент id
Эл-т |
Тип |
По-умолчанию |
Условие |
Описание |
typeName |
string |
|
|
Тип заявки |
StatusName |
string |
|
|
Статус заявки |
date |
string |
|
|
Дата исполнения заявки |
cost |
float |
|
|
Стоимость услуги |
customerCost |
float |
|
|
Сумма с покупателя |
specificationId |
int |
|
|
Номер детализации, если заявка уже попала в архив |
log |
string |
|
|
Лог заявки |
Пример использования на PHP
/*
* Ваш массив с данными заявки.
* Массив создан только из тех элментов, которые имеются по заявке.
* Этот массив в дальнейшем объединяется с базовым
*/
$array=array(
"apiKey"=>"{apiKey}",
"ordersString"=>"{clientOrders}",
"inWork"=>false,
"whereIsMyMoney"=>false
);
/**
* Функция подключения и передачи JSON-объекта на сайт api.2f1.ru
*
* @param array $request
* @return array
*/
function _2f1_api_communicate($request=null){
/*
* Базовый массив. Не убирайте его или его элменты.
* В случае если в Вашем массиве нехватает элментов,
* они будут дополнены из этого.
* API проверяет целостность и структуру массива, который вы ему скармливаете.
* Если чего-то неватает, то и работать ничего не будет.
*/
$array=array(
"apiKey"=>"", //API-КЛЮЧ
"ordersString"=>"all", //НОМЕРА ЗАКАЗОВ
"inWork"=>false,
"whereIsMyMoney"=>false
);
//Слияние массивов
if(isset($request)&&is_array($request)) $array=array_merge($array,$request);
$json = json_encode($array); // Преобразование массива в JSON
/*
* Собственно сама отправка данных.
* Не меняйте этот блок. Его изменение ничего хорошего Вам не даст.
* */
$curl = curl_init();
curl_setopt($curl, CURLOPT_URL, "http://api.2f1.ru/checkorders/");
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, $json);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
$data = curl_exec($curl);
curl_close($curl);
if($data === false) return array("error"=>true,"errorDescription"=>"Не получены данные от сервера");
$jsonAnsver = json_decode($data, $assoc=true);
return $jsonAnsver;
}
$a=_2f1_api_communicate($array);
/*
* С полученым ответом Вы вольны распоряжаться как Вам будет угодно.
* Кроме номера заказа, Вы получаете стоимость услуг Курьерской службы, а также сумму которую курьер берет с покупателя.
* Вся нужная Вам информация хранится в массиве OUT
*/
echo ""; // < pre >
var_dump($a);
echo "
"; // < pre >