Overview #
Welcome to the QCentroid Platform REST API Getting Started guide. This overview explains the basic concepts and usage of the QCentroid Platform REST API.
Glossary #
Here is part of the terminology that you will hear a lot from now on.
- API stands for Application Programming Interface. In the context of APIs, the word Application refers to any software with a distinct function. An API documentation contains information on how developers are to structure the requests and responses used to communicate applications with each other.
- JSON is a text-based data format that is used to store and transfer data. It’s a way of representing JavaScript object literals, arrays, and scalar data.
- Postman is an API platform for building and using APIs.
- curl (cURL) is a command-line tool that lets you transmit HTTP requests and receive responses from the command line or a shell script. It is available for Linux distributions, Mac OS X, and Windows.
Endpoints #
Base endpoint #
| Base URL | https://api.qcentroid.xyz |
Other endpoints #
| Function | Endpoint | Methods allowed |
|---|---|---|
| Login | /login | POST |
| Run solvers for a problem | /problem/{problem_name} | POST |
| Get list of Jobs | /jobs | GET |
| Get a single Job | /job/{job_id} | GET |
Postman API client #
A quick way to start making requests to QCentroid Platform API is by using a graphic UI API client such as Postman.
Postman is available for Windows, Mac OS X and Linux and it’s free to use. You can get it here.
