We have released the first version of our API to allow you access to the data in the directory. The initial implementation is very limited, however improvements will made as usage increases.
How To Start
Step 1: Register as a user and request an API Key
Once you have registered go to the My Account screen to request an API Key. Your key is unique to your user id and all usage of the API will be tracked against your User Id, please keep your key secret.
Step 2: Use as you wish
Usage
The initial implementation allows you to return a listing of vendors from the directory in JSON format. The API takes a series of name-value pairs to describe the parameters section.
URL:
http://directory.inspecht.com.au/?api=API Key&Parameters
HTTP Method(s):
GET
Requires API Key:
true
Parameters:
- num : Mandatory. Indicates the number of rows to return, -1 indicates all records.
- id : Optional. The ID of a specific vendor to return, see the vendors page for the ID.
- cat : Optional. The major category that you want to return, see list of potential categories below. Only a single category is currently supported.
Categories:
- business-intelligence
- consultancy
- core-hrpayroll
- hr-service-delivery
- recruiter-tools
- talent-management
- workforce-management
Response:
The response is a JSON text stream.
[
{"id":12,
"company":"My Company",
"excerpt":"Some interesting text about the company goes here",
"url":"http:\/\/mydomain.com\/",
"founded":"1999",
"ownership":"Privately Held",
"categories":"Consultancy "},
{"id":96,
"company":"Another Company",
"excerpt":"Some interesting text about the company goes here",
"url":"http:\/\/another_domain.com",
"founded":"2008",
"ownership":"Privately Held",
"categories":"Talent Management "}
]
Usage Example:
http://directory.inspecht.com.au/?api=cbb8f354a8a141c07226cc53c018f077&num=2&cat=consultancy
Returns the first two vendors in the Consultancy category ordered by date registered in the directory.
http://directory.inspecht.com.au/?api=cbb8f354a8a141c07226cc53c018f077&id=77
Returns the vendor with the id of 77.
