Help

Common

API works only over HTTPS.

All API methods are asynchronous methods.

All API calls (except OAuth ones) must contain the Authorization header:

Authorization: OAUTH oauth_token="pfl4PLrrHKChIRoDS2O9Wfoyr1yjKgbEjCxk+", api_key="10D35802-C92A-42B3-88FC-A4489A3CD619"

All API calls return XML or JSON response based on the request header Accept values. In the request example listings, for simplification, we will show only one value. Recommended header values are (using other accept header values could lead to unexpected results):

application/json; charset=utf-8
if the expected response content is JSON
application/xml; charset=utf-8
if the expected response content is XML

All 500 - Internal Server Error will not display the content of the error but an identificator. Please contact Gryphtech Support if this happens to you and provide the gt-tracker-id and any other details might help us identify and correct the problem.

Unsuccessfull calls

In general, if something goes wrong, we try to display the reason. Apart from messages returned by the IIS and .NET framework, like 404 - Not found, if you use a wrong url for instance, you might get following errors:

400 - Bad Request

If not all required parameters were transmitted or they were transmitted in the wrong format (i.e. not URL encoded) or they have wrong values or the required headers are missing or they have the wrong values.

401 - Unauthorized

The API could not authenticate your call based on the Authorization header provided in the request. We will try to offer a hint why it happened.

403 - Forbidden

The request was not done over HTTPS.

You will get 403 - Forbidden also if you make the request from a web page, using AJAX, like our test page. This behaviour is intentional and it was implemented to prevent browser basic authentication challenge (username and password pop-up window) in this case. Our Ajax method, from the test page, will receive 403 but will display it as 401 for specific calls.

If the request header contains X-Requested-With: XMLHttpRequest then instead of 401 reponse you will get a 403 response but you should interpret it as 401. This is happening in the authentication part only.

409 - Conflict

You try to create a resource witht the same ID as the ID of an existing one.

500 - Internal Server Error

This is an error we do not want to see it at all but if it shows it means that something wrong happened in our application or on our servers. It is not your fault. You should not get details of the error except a gt-tracker-id identificator. Please contact Gryphtech Support and provide the gt-tracker-id and any other details might help us identify and correct the problem.