Topology Finder API

Документация по работе с API сервиса поиска топологии

Основной адрес

http://api.topcryst.com/v1

GET /help

Эта страница — краткое описание API.

POST /login

Авторизация пользователя и получение ключа API.

Параметры: user — имя пользователя

password — пароль пользователя

Возвращает: JSON-объект


        {'result': 'error', 'message': 'invalid username or password'}


        {'result': 'success', 'key': apikey}

POST /addtask

Добавление задачи расчёта в очередь.

Параметры: key — apikey (ключ API)

file — CIF-файл

Возвращает: JSON-объект


        {'result': 'success','task': task_id, 'message': 'Task added to the queue'}


        {'result': 'error', 'message': errormessage}

GET /getresult

Получение результатов задачи.

Параметры: key — apikey (ключ API)

task — task_id (идентификатор задачи)

Возвращает: ZIP-файл с результатами (task_id.zip)

или JSON-объект


        {'result': 'error', 'message': 'Task not ready'}

GET /history

История запросов — ещё не реализовано.

GET /userinfo

Информация о пользователе — ещё не реализовано.