API Overview
API 360°
Our modular platform is built to not only run as a stand-alone but also be integrated into any existing system. Company API, Director API, Partners/Members/Certification API, Court Cases API, Company Products / Services API, RERA API, CESTAT API, ITAT API, Suit Filed API, Tenders API, Auctions API
Overview
The 99corporates API is a simple, lightweight REST API that responds to http requests with JSON (future support for XML is planned). Because it is a REST API, it is completely stateless. Requests are expected to be made in the form of a simple HTTP GET.
The APIs that are not provided publicly and are available to our API partners only. If you're interested in becoming an API partner, please contact us.
Technology
99corporates team opinion about RESTfull web services is that it is lightweight, maintainable and scalable service that is built on the REST architecture. RESTfull architecture provides us the best way to develop cross platforms application using the latest framework available Asp.Net Core Web API ( .Net Core 6 ).
Attribution
You must use the following attribution when displaying 99corporates's API results. Copy the code below and paste it near the results on your web page:
Request Structure
All 99corporates API requests share some common parameters, and a typical call will look like this:
https://api.99corporates.com/api/api.htm?v=1&format=json&t.p=120&t.k=fz6JLNDfgVs&action=employers&q=pharmaceuticals&userip=195.165.143.28&useragent=Mozilla/%2F4.0
The common required parameters here are:
| Parameter | Explanation | Required? |
|---|
| v | The API version. The current version is 1 | Yes |
| format | Either xml or json as you prefer | Yes |
| pid | Your partner id, as assigned by 99corporates | Yes |
| pkey | Your partner key, as assigned by 99corporates | Yes |
| userip | The IP address of the end user to whom the API results will be shown | Yes |
| useragent | The User-Agent (browser) of the end user to whom the API results will be shown. Note that you can can obtain this from the "User-Agent" HTTP request header from the end-user | Yes |
| callback | If json is the requested format, you may specify a jsonp callback here, allowing you to make cross-domain calls to the 99corporates API from your client-side javascript. See the JSONP wikipedia entry for more information on jsonp. | No |
| action | The particular API call that you would like to make - see jobs, reviews, salaries, etc. sub-sections for details | Yes |
| other | Each API action will require different parameters. | Varies |
Response Structure
All requests will return at least status information, and a typical json response will look like this:
{"success": true,"status": "OK","response": {}}
Response Codes
You can always count on a high level success flag which will be either true or false, and status which will typically indicate additional information. If the call is successful, there will be a 'response' block. Common statuses are:
- OK: request succeeded
- Access-Denied: your partner id/key are not correct, or not specified. Check the pid and pkey params in your request
- Call-specific errors: for example on data retrieval, it can return Data-Not-Found
