Introduction
The VendorRisk API is HTTP-based and uses the following format:
https://{your-site}.vendorrisk.com/api/v1/{module}.{format}?token={api_key}
And:
https://{your-site}.vendorrisk.com/api/v1/{module}/{item}.{format}?token={api_key}
Where:
- {your-site} — your VendorRisk sub-domain
- {module} — can be vendors, contracts, services, software, hardware or users
- {item} — if viewing an individual item, the unique permalink for that item
- {format} — currently xml is the only available format
- {api_key} — accessible via the Admin section of your VendorRisk account
The API currently supports the GET method only, which means you can use the API to view information in your VendorRisk site, but cannot create, update or delete information via the API. If you use Firefox, you can enter an API URL in the browser and it will display a nicely formatted view of the information.
Please also be aware of the following:
- All API requests should use the https:// protocol
- The API will return all items in a module (e.g. all the vendors entered into the system), not just the items a particular user may have access to
- If you need to reset the API key, login to your site, click the "Admin" link, and then the "API Access" link
Error Messages
A 404 error will be returned if any of the following are true:
- An invalid API token is used
- An invalid format is used, or none is specified
- The module does not exist
- The item does not exist, if attempting to access a specific item
