1. API Overview
Juvlon’s API allows you to integrate your application directly to your Juvlon account. This documentation is intended for programmers who write application programs that interact with your Juvlon account.
This documentation assumes that you understand
- Juvlon and it’s functionalities
- General principles behind the any programming languages and concepts, code examples and links to sample code provided.
This documentation explains all commands available to use Juvlon through your own program. It covers all aspects including detailed explanation about API, Parameters, Return values, Examples, Sample Error and Success responses of Juvlon’s APIs.
1.2 API Usage
Every client is provided with a unique API Key that needs to be used as part of each request to the Juvlon’s API service. APIs are enabled by default in your Juvlon account. You can generate an API Key by logging in and going to My Account > API Key.
The APIs for all the consumers have been hosted at:
https://api2.juvlon.com/[apiName]
To make a call to any Juvlon’s API, one need to POST your HTTP requests in JSON format. All requests from your application to Juvlon are expected to be coming in JSON format and in POST (not GET) method. Of course, the data and parameters will vary depending on the API that you are using. The size of the entire HTTP post should not exceed 32 MB.
To ensure maximum privacy for clients and their data over web, Juvlon’s APIs are only accessible via SSL. Using SSL ensures that the data transferred to Juvlon remains secure and cannot be intercepted by potential eavesdroppers.
1.3 API Rate Limit
You can make 100 API Requests every 5 minutes.
1.4 Error handling and Timeouts
Juvlon APIs have well defined error handling and responding mechanism. The first digit of the status code specifies one of five classes of response; the bare minimum for an HTTP client is that it recognizes these five types.
1.5 API Usage
Java Scripts are simple to use and yet powerful. Juvlon APIs are also using Java Scripts and you need to include one Java Script file in your Programs. This file contains a wrapper what intern uses Java Scripts for jQuery and JSON.
All the requests from your application to Juvlon are expected to be coming in JSON format and in POST (not GET) method. Off-course, the data and parameters will vary depending the API that you are using.
1.6 Error handling and Timeouts
Juvlon APIs have well defined error handling and responding mechanism. The first digit of the status code specifies one of five classes of response; the bare minimum for an HTTP client is that it recognizes these five types.
1xx : Informational 2xx : Success 3xx : Redirection 4xx : Client Error 5xx : Server Error e.g. 1. Codes starting with 2 (e.g. 200) are considered to be "Success" or "Processed". 2.Codes starting with 4 (e.g. 400, 401, 412) are considered Client Errors: the caller/client is doing something wrong and the payload should present you a possible solution to the problem; 3. Codes starting with 5 (e.g. 500, 503, 504) are considered Server Errors: there is something wrong with the way the server is handling your request and the payload should give you more details about the situation, including if it's permanent or temporary.
On occasion, your application may experience a timeout when calling Juvlon’s API. The timeout will appear as an HTTP error with a useful error message in the HTTP Header. It could be that you exceeded the number of queries per second or day in your Terms of Service or it is possible that you were denied access due to the aggregate queries per second limit. The aggregate queries per second limit is a fail-safe of Juvlon’s API, where the system denies all requests over a certain amount per second (set by Juvlon) to ensure the stability of the Juvlon’s environment. This second type of timeout should only happen in the rarest of situations.
1.7 Testing Juvlon APIs
You can test a Juvlon API using a third-party API testing tool like APITester.com. Detailed instructions for testing our API are provided here.
1.8 Active and Deprecated APIs
Juvlon is continuously getting upgraded with new functionality and Juvlon’s API might get optimized over period of time. As a result of this optimization, few APIs will get deprecated and will not be supported by Juvlon. Of course, the same functionality can be supported by different API.
This process of deprecation is intended to allow us to make changes to the APIs that are not backward compatible. This will also allow us to better deliver new functionality as well as make improvements to existing functionality. Be aware that all the Active APIs will appear under “Active APIs” and the deprecated APIs will under “Deprecated” in the left side tree.
2. Juvlon’s API Support
For any support with Juvlon’s API, please email Juvlon Support and we will help you at earliest possible.