Access and Authentication

URL

The HTTP API is available at:

https://httpapi.com/

 

Note

For security reasons, you should always send API requests using HTTPS.

Authentication

All requests require the following authentication parameters:

  • auth-userid: Your Live Account Reseller Id (See the instructions below for finding your Reseller Id).

  • api-key: An alphanumeric code that can be used to authenticate your API calls (See the instructions below for finding your API Key),

Locating your Reseller Id

  1. Login to your Reseller Control Panel. See details

  2. Click the icon at the top right corner of the page and then click Manage Profile.

  3. In the Reseller Profile Details view that is now displayed, the first field indicates your Reseller Id.

Locating your API Key

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Settings and then click API.

  3. Click the View API key link under the API Key section. Your unique API Key will be displayed in a pop-up window over a secure connection.

  4. You may generate a fresh API Key by clicking the Regenerate link.

    Note

    Generating a fresh API Key will invalidate your old API Key immediately and this will have an impact on your existing API calls. Please exercise caution while generating a new API Key.

Whitelisting your IP Address(es)

  1. Login to your Reseller Control Panel. See details

  2. In the Menu, point to Settings and then click API.

  3. Under the Whitelist your IP Addresses section, specify the IP Addresses from where you will be making API requests and then click the Save whitelisted IP addresses button.

    Note

    IP ranges and netblocks are not accepted.

Whitelisting additional IP address

The Control Panel gives you the provision of whitelisting up to 3 IP addresses from where you can make API calls to our servers. However, if you feel that you would need to whitelist any additional IP addresses, you can contact our support team at http://www.combaba.com for assistance to add the additional IPs from the backend.

Note

It can take 30 minutes - 1 hour for the IP address to be white-listed in the system. You can check if an IP has been whitelisted by running a sample API call from the desired IP address. If you receive the following response: “Access Denied. You are not allowed to perform this action” it means that the IP address has not yet been white-listed. You may wait for the whitelisting duration to lapse or contact our Support team for further assistance.

Testing / Trying out the API

The HTTP API requires that all requests to retrieve data should use the GET method and requests that submit, change, or destroy data should use the POST method. Requests that require a particular HTTP method will return an error if you do not make your request with the correct method.

However, to make it easy for you to try out and test the API using the browser or command line tools, we have made available a special Test URL that allows you to make any request using the GET method. Example Test URL requests are provided for all API requests.

The Test URL

https://test.httpapi.com/

Note

  • The Test URL should only be used for trying out or testing the API via the browser/command line tools and should not be used in production environments.

  • We always recommend usage of a Demo Account Reseller Id and Password with the Test URL for authentication as against usage of your Live Account credentials. Usage of your Live Account credentials, even with the Test URL, will result in actions being performed in production environments.

    Additional Information

    Sign up for a Demo Reseller Account

  • In case of any errors, a HTTP status 500, alongwith a relevant error message will be returned.