API Documentation — version 1

Services

Sample API URLs

To get all services:

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

XML output:


<services>
  <service>
    [see fields below]
  </service>
  <service>
    [see fields below]
  </service>
</services>

To get a specific service:

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

XML output:


<service>
  <vendor>Sample Vendor</vendor>
  <name>IT Consulting</name>
  <user>John Doe</user>
  <contract>Consulting Contract</contract>
  <service_type>Consulting</service_type>
  <location>Outsourced</location>
  <cost>100000</cost>
  <description>Consulting on our IT infrastructure</description>
  <watchlist>No</watchlist>
  <watchlist_reason></watchlist_reason>
  <watchlist_mitigation></watchlist_mitigation>
  <risk_level>Low</risk_level>
  <non_public_data>Yes</non_public_data>
  <confidential>Yes</confidential>
  <insurance></insurance>
  <insurance_details></insurance_details>
  <third_party_required></third_party_required>
  <third_party></third_party>
  <third_party_other></third_party_other>
  <review_frequency>6 months</review_frequency>
  <permalink>it-consulting</permalink>
  <created_at>11/30/2009 8:00 PM</created_at>
  <updated_at>11/30/2009 8:00 PM</updated_at>
</service>