API Documentation — version 1

• Overview
• Vendors
• Contracts
• Services
• Software
• Hardware
• Users
• Departments

Sample API URLs

To get all software items:

https://{your-site}.vendorrisk.com/api/v1/software.xml?token={api_key}

XML output:

<softwares>
  <software>
    [see fields below]
  </software>
  <software>
    [see fields below]
  </software>
</softwares>

To get a specific software item:

https://{your-site}.vendorrisk.com/api/v1/software/sample-software.xml?token={api_key}

XML output:

<software>
  <vendor>Sample Vendor</vendor>
  <name>Firewall Monitoring Software</name>
  <user>John Doe</user>
  <contract>Software contract</contract>
  <cost>25000</cost>
  <cost_notes></cost_notes>
  <po_number>12345-6789</po_number>
  <software_type>Server software</software_type>
  <location>In-house</location>
  <licensed_users>1</licensed_users>
  <password_policy></password_policy>
  <description>Monitors incoming and outgoing traffic</description>
  <last_upgrade_date>10/31/2009</last_upgrade_date>
  <last_upgrade_details></last_upgrade_details>
  <acquired_date>12/11/2008</acquired_date>
  <retired_date>12/11/2012</retired_date>
  <support_end_date>12/11/2010</support_end_date>
  <admin>Jane Doe</admin>
  <reviewer>John Doe</reviewer>
  <watchlist>Yes</watchlist>
  <watchlist_reason>New version may be buggy</watchlist_reason>
  <watchlist_mitigation></watchlist_mitigation>
  <risk_level>High</risk_level>
  <non_public_data>Yes</non_public_data>
  <financial_data>Yes</financial_data>
  <third_party_required></third_party_required>
  <third_party></third_party>
  <third_party_other></third_party_other>
  <recovery_time>4 hours</recovery_time>
  <recovery_point>2 hours</recovery_point>
  <review_frequency>Quarterly</review_frequency>
  <permalink>firewall-monitoring-software</permalink>
  <created_at>11/30/2009 8:00 PM</created_at>
  <updated_at>12/25/2009 8:00 PM</updated_at>
</software>