Rest API Upload to service (rus) - datawizio/pythonAPI GitHub Wiki

Функции для управления загрузкой данных на сервис

Параметр Значение
function upload_to_service
clear_client
cache_data
email <email>
Е-мэйл, на который придет оповещение об окончании функции

POST /api/v1/utils/

Upload to service

Функция загружает данные пользователя на сервис и запускает процесс кеширования. Пример запроса:

POST /api/v1/utils/
   {
    "function": "upload_to_service"
    "email": "[email protected]"
   }

Ответ сервера:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task was started."}

Пример ответа с ошыбкою:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task start failed. Perhaps, another task still running"}

Cache data

Функция запускает процесс кеширования данных. Принимает два необязательные параметры:
date_list - список дат, за которые нужно закешировать данные
Пример запроса:

POST /api/v1/utils/
   {
    "function": "cache_data"
    "date_list": ["2016-2-1","2016-2-2",...],
    "email": "[email protected]"
   }

Ответ сервера:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task was started."}

Пример ответа с ошибкой:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task start failed. Perhaps, another task still running"}

Clear client

Функция очищает все данные пользователя

POST /api/v1/utils/
   {
    "function": "clear_client",
    "email": "[email protected]"
   }

Ответ сервера:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task was started."}

Пример ответа с ошибкой:

HTTP 200 OK 
Content-Type: application/json 
Vary: Accept
Allow: POST
{"results": "Task start failed. Perhaps, another task still running"}
Add a custom footer
⚠️ **GitHub.com Fallback** ⚠️