Addressbook OAuth REST API Example performed with the Virtuoso OAuth Testing Tool

The following example demonstrates creating and getting contact info by the ODS REST APIs addressbook.new and addressbook.get using the OAuth Test Tool. Full list of the ODS REST APIs for ODS Addressbook you can find here.

  1. Go to http://demo.openlinksw.com/ods
  2. Log in as user demo with password demo
  3. Go to Settings->OAuth Keys
  4. Copy the Token value for an Addressbook instance or create such in not existing. For ex.: e0a49e54603740f67f8b8f3f58651ad772dc9b44
  5. Go to http://demo.openlinksw.com/ods/oauth_test.vsp
  6. In the shown form enter for:
    1. Server: http://demo.openlinksw.com/ods/api
    2. Consumer Key: e0a49e54603740f67f8b8f3f58651ad772dc9b44
    3. API method: addressbook.new
    4. API parameters: 

      inst_id=36&name=TEST

      • An easy way to get the instance id is using the ODS Framework Controller instance.get.id: 

        $ curl -i "http://demo.openlinksw.com/ods/api/instance.get.id?user_name=demo&password_hash=4627dhe23cb53f522eag32e09gs7fceaw2c523449bdfdf&instanceName=demo's%20AddressBook"
HTTP/1.1 200 OK
Server: Virtuoso/06.03.3131 (Linux) x86_64-generic-linux-glibc25-64  VDB
Connection: Keep-Alive
Date: Sun, 05 Feb 2012 21:01:20 GMT
Accept-Ranges: bytes
Content-Type: text/xml; charset="UTF-8"
Content-Length: 58

<result>
  <code>36</code>
  <message>Success</message>
</result>

      • You can also get the instance id using the ODS Ubiquity commands sequence: 

        ods-host http://demo.openlinksw.com/ods
ods-set-mode sid
ods-authenticate-user demo password demo
ods-get-instance-id demo's AddressBook

    5. Select for Query options: "Generate URI and Submit".
  7. Click the "Execute" button.
  8. In the shown authorization form click the "Authorize" button.
  9. As result will be shown the generated URI and the output message of executing the ODS REST API. In our case, the id of the new created contact will be: 1046
  10. Now lets get the data for the created contact. In the form enter:
    1. API method: addressbook.get
    2. API parameters: contact_id=1046
    3. Select for Query options: "Generate URI and Submit".
  11. Click the "Execute" button.
  12. As result in the "Response Body" text-area will be shown the retrieved details for the contact with the given above id.

Related

CategoryAddressBook CategoryODS