API

Все запросы к серверу формируются в виде GET-запросов с параметрами, переданными в кодировке application/x-www-form-urlencoded. Возможны два варианта авторизации:

• По токену (получить токен можно в личном кабинете). Нужно установить токен в заголовок X_API_KEY. В этом случае запросы выглядат следующим образом

  https://gaek.net/api/<имя функции>?<параметры>

  где
  • <имя функции> - имя вызываемой функции, например: getPrice, getBasketItems, addBasketItem
  • <параметры> - параметры необходимые для вызываемой функции
  
  Пример запроса:

  https://gaek.net/api/getPrice?productName=12345&developerName=ford

  Получить токен можно в личном кабинете
  
  
• По связке логин-пароль. Нужно передать в URL-запосе параметры login и password. В этом случае запросы выглядат следующим образом

  https://gaek.net/api/<имя функции>?login=<логин>&password=<пароль>&<другие параметры>

  где
  • <имя функции> - имя вызываемой функции, например: getPrice, getBasketItems, addBasketItem
  • <логин> - логин пользователя на сайте
  • <пароль> - пароль пользователя на сайте
  • <другие параметры> - другие параметры необходимые для вызываемой функции
  
  Пример запроса:

  https://gaek.net/api/getPrice?login=userlogin&password=userpassword&productName=12345&developerName=ford

    {
        msg: <сообщение об ошибке>,
    }
    

Список функций

    {
        "msg": <описание ошибки>,
        "data": [
            "developerName": <код производителя>,
            "developerCaption": <название производителя>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "deliveryWork": <срок поставки в банковских днях>,
            "deliveryCalendar": <срок поставки в календарных днях>,
            "count": <доступное количество>,
            "countStep": <минимальная партия (кратность)>,
            "price": <цена>,
            "searchId": <идентификатор торгового предложения, используемый для заказа>,
        ]
    }

    {
        "msg": <описание ошибки>,
        "data": [
            "id": <идентификатор позиции>,
            "developerCaption": <название производителя>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "deliveryWork": <срок поставки в банковских днях>,
            "deliveryCalendar": <срок поставки в календарных днях>,
            "count": <количество>,
            "price": <цена>,
            "maximum": <количество, доступное для заказа>,
        ]
    }

    {
        "msg": <описание ошибки>,
        "id": <идентификатор добавленной позиции>
    } 

    {
        "msg": <описание ошибки>,
    }

    {
        "msg": <описание ошибки>,
    }

    {
        "msg": <описание ошибки>,
        "id": <идентификатор нового заказа>,
    }

    {
        "msg": <описание ошибки>,
        "id": <идентификатор нового заказа>,
        "list": <массив идентификаторов позиций в корзине не прошедших проверку (должны входить в заказ клиента)>,
    }

    {
        "msg": <описание ошибки>,
        "data": [
            "documentId": <идентификатор документа>,
            "deliveryTypeId": <идентификатор способа доставки>,
            "paymentTypeId": <идентификатор способа оплаты>,
            "number": <номер документа>,
            "date": <дата документа>,
            "state": <статус документа>,
            "manager": <менеджер>,
            "debt": <задолженность по документу>,
            "sum": <сумма документа>,
            "items": [
                "documentId": <идентификатор документа>,
                "date": <дата документа>,
                "developerCaption": <производитель>,
                "productName": <номер детали>,
                "productCaption": <название детали>,
                "count": <количество>,
                "price": <цена>,
                "sum": <сумма>,
                "deliveryDate": <дата доставки>,
                "state": <статус позиции>, 
            ]
        ]
    }

    {
        "msg": <описание ошибки>,
        "data": [
            "documentId": <идентификатор документа>,
            "documentItemId": <идентификатор позиции в заказе>,
            "date": <дата документа>,
            "developerCaption": <производитель>,
            "productName": <номер детали>,
            "productCaption": <название детали>,
            "count": <количество>,
            "price": <цена>,
            "sum": <сумма>,
            "deliveryDate": <дата доставки>,
            "state": <статус позиции>, 
        ]
    }

    {
        "msg": <описание ошибки>,
        "data": [
            "caption": наименование производителя,
            "name": код производителя,
        ]
    }

Статусы заказов

• Корзина
• Новый
• Выставлен счет
• В работе
• Выполнен
• Отгружен
• Аннулирован

Статусы позиций в заказах

• Создана
• Аннулирована
• Выставлен счет
• Бронь
• Возврат клиента
• В пути
• Заказана поставщику
• Отгружена клиенту
• Отказ клиента
• Отказ поставщика
• Сборка

Примеры

• Пример обработки для 1С8.3
  Авторизация при помощи токена

      HTTPСоединение = Новый HTTPСоединение("gaek.net",,,,,, Новый ЗащищенноеСоединениеOpenSSL);
      HTTPЗапрос = Новый HTTPЗапрос("/api/getPrice?productName=123");
      HTTPЗапрос.Заголовки.Вставить("Content-type", "application/x-www-form-urlencoded;charset=utf-8");
      HTTPЗапрос.Заголовки.Вставить("X_API_KEY", "Ваш токен");
      HTTPОтвет = HTTPСоединение.Получить(HTTPЗапрос);
      ТекстОтвета = HTTPОтвет.ПолучитьТелоКакСтроку();            
              

• Работа с API через fetch
  Авторизация при помощи токена

      fetch('https://gaek.net/api/getPrice?productName=123', {
          method: 'GET',
          headers: {
              'X_API_KEY': 'Ваш токен',
          }
      })
      .then(response => response.json())
      .then(data => console.log(data))
      .catch(error => console.error('Error:', error));
              

  Авторизация при помощи логина и пароля

      fetch('https://gaek.net/api/getPrice?productName=123&login=login&password=password', {
          method: 'GET',
      })
      .then(response => response.json())
      .then(data => console.log(data))
      .catch(error => console.error('Error:', error));
              

• Работа с API через PHP
  Авторизация при помощи токена

      $curl = curl_init();
      curl_setopt($curl, CURLOPT_URL, "https://gaek.net/api/getPrice?productName=12345");
      curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
      curl_setopt($curl, CURLOPT_HTTPHEADER, array('X_API_KEY: Ваш токен'));
      $out = curl_exec($curl);
      if($out === false)
      {
          echo "Error Number:".curl_errno($curl);
          echo "Error String:".curl_error($curl);
      }
      else{
          $result = $out;
          $data = json_decode($result);
          print_r($data);
      }
      curl_close($curl);
              

  Авторизация при помощи логина и пароля

      $curl = curl_init();
      curl_setopt($curl, CURLOPT_URL, "https://gaek.net/api/getPrice?login=user&password=pass&productName=12345");
      curl_setopt($curl, CURLOPT_RETURNTRANSFER,true);
      $out = curl_exec($curl);
      if($out === false)
      {
          echo "Error Number:".curl_errno($curl);
          echo "Error String:".curl_error($curl);
      }
      else{
          $result = $out;
          $data = json_decode($result);
          print_r($data);
      }
      curl_close($curl);