API 1.1

From Aviberry API

Jump to: navigation, search

Still have a question?


Aviberry API calls can be executed by requests via GET and POST methods. Generally, URL request for GET method looks this way:

http://api_key:api_pass@aviberry.com/api/v1.1/protocol/method?param=value

, where

  • api_key and api_pass - key and password to identify the user, making API calls (mandatory fields);
  • protocol - used data-interchange protocol: "json" or "xml" (mandatory field);
  • method - method name for making call (mandatory field);
  • param and value - name and value of parameter transfered to method.

Therefore if the call is executed via GET method, than method name and transered parameters are included in the URL request. For POST method the URL request looks differently:

http://api_key:api_pass@aviberry.com/api/v1.1/protocol/

In this case method name and transfered parameters are coded in the body of POST request. For protocol JSON-RPC there should be a JSON-encoded object with standard coded method and parameters in the body of request, and for protocol XML-RPC - XML-encoded object with the same standard coded method and parameters. According to the protocol used for making a call, server will choose the response format. All transfered string data should be UTF-8 encoded unless otherwise specified.
JSON-RPC protocol support up to 2.0 inclusive.

Key and password for API access can be generated and regenerated on account page at any time.

Contents




Still have a question?

Views
Personal tools