Topology Finder API

Documentation for the topology search service API

Base URL

http://api.topcryst.com

Endpoints

GET /help

This page — a brief API description.

POST /login

User authentication and API key retrieval.

Parameters: user — user name
password — user password
Returns: JSON object
{'result': 'error', 'message': 'invalid username or password'} {'result': 'success', 'key': apikey}
POST /addtask

Add a calculation task to the queue.

Parameters: key — apikey
file — CIF file
Returns: JSON object
{'result': 'success','task': task_id, 'message': 'Task added to the queue'} {'result': 'error', 'message': errormessage}
GET /getresult

Get the results of a task.

Parameters: key — apikey
task — task_id
Returns: ZIP file with results (task_id.zip)
ZIP file with results (task_id.zip) {'result': 'error', 'message': 'Task not ready'}