All Collections
API Documentation
oAuth API
General information about the Startquestion API
General information about the Startquestion API
Artur Zbiejcik avatar
Written by Artur Zbiejcik
Updated over a week ago

The Startquestion API enables access to resources of the Startquestion.com website using the JSON interface. The above makes it possible to create external applications that can be integrated with the Startquestion.com user account.

Service URL

The API access point (base URL) can be found at:

https://www.startquestion.com/api/v2


Access is provided through an encrypted connection (https://).

REST, REST-like

The Startquestion API operations are organized according to the REST style. This means that the URL address identifies a certain resource whereas the action that has to be performed is described on the basis of the appropriate URL segments and the GET, POST method.

  • GET – downloading information regarding a resource or deleting a resource with a specified identifier

  • POST – creating a new resource or changing an existing one

The format of returned answer

Startquestion API returns answers in the JSON format.

Coding

All data sent to the Startquestion API should be coded in the UTF-8 format.

Encryption

Encryption takes place using the oAuth2 protocol. For the purpose of mobile and desktop applications it was modified so that authorization can take place using the login and password of a user.

The key and API Secret can be found in the Account Settings in the Integrations section.

Status/error codes

The result of the query can be specified on the basis of an HTTP error code.
The following codes are used in Startquestion API:

  • 200 OK – The query has been performed correctly

  • 400 Bad Request – The parameter has an incorrect value or the parameter value is not within the specified set.

  • 401 Unauthorized – No authorization or rights to a given resource.

  • 402 Payment Required – Limitations of the purchased package make access to the resource impossible.

  • 404 Not Found – Resource not found or non-existent.

  • 406 Not Acceptable – The required parameter was not provided.

  • 409 Conflict – Code returned after an unsuccessful attempt of saving data (e.g. activating a survey).

  • 500 Internal Server Error – Code returned if an internal server error occurs.

Did this answer your question?