---+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 [[VirtuosoOdsControllersAddressbook][here]].

   1. Go to http://demo.openlinksw.com/ods
   1. Log in as user demo with password demo
   1. Go to Settings->OAuth Keys
      * <img src="%ATTACHURLPATH%/o1.png" style="wikiautogen"/>
   1. Copy the Token value for an Addressbook instance or create such in not existing. For ex.: e0a49e54603740f67f8b8f3f58651ad772dc9b44
   1. Go to http://demo.openlinksw.com/ods/oauth_test.vsp
   1. In the shown form enter for:
      1. *Server*: http://demo.openlinksw.com/ods/api
      1. *Consumer Key*: e0a49e54603740f67f8b8f3f58651ad772dc9b44
      1. *API method*: addressbook.new
      1. *API parameters*: 
<verbatim>
inst_id=36&name=TEST
</verbatim>
         * An easy way to get the instance id is using the [[VirtuosoOdsControllers][ODS Framework Controller]]  <b>instance.get.id</b>:
<verbatim>
$ 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>
</verbatim>
         * You can also get the instance id using the [[VirtuosoOdsUbiquity][ODS Ubiquity commands]] sequence:
<verbatim>
ods-host http://demo.openlinksw.com/ods
ods-set-mode sid
ods-authenticate-user demo password demo
ods-get-instance-id demo's AddressBook
</verbatim>
      1. Select for *Query options*: "Generate URI and Submit".
      * <img src="%ATTACHURLPATH%/oa1.png" style="wikiautogen"/>
   1. Click the "Execute" button.
   1. In the shown authorization form click the "Authorize" button.
      * <img src="%ATTACHURLPATH%/oa2.png" style="wikiautogen"/>
   1. 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
      * <img src="%ATTACHURLPATH%/oa3.png" style="wikiautogen"/>
   1. Now lets get the data for the created contact. In the form enter:
      1. *API method*: addressbook.get
      1. *API parameters*: contact_id=1046
      1. Select for *Query options*: "Generate URI and Submit".
   1. Click the "Execute" button.
   1. As result in the "Response Body" text-area will be shown the retrieved details for the contact with the given above id.
      * <img src="%ATTACHURLPATH%/oa4.png" style="wikiautogen"/>  


---++Related

   * [[VirtuosoOdsControllersAddressbook][Addressbook REST Controllers]]
   * [[VirtOAuthTestTool][OAuth Test Tool for ODS Controllers]] - Examples:
      * [[VirtOAuthTestToolExampleBriefcase][ODS Briefcase]]
      * [[VirtOAuthTestToolExampleWeblog][ODS Weblog]]
      * [[VirtOAuthTestToolExampleBookmarks][ODS Bookmarks]]
      * [[VirtOAuthTestToolExamplePolls][ODS Polls]]
      * [[VirtOAuthTestToolExampleCalendar][ODS Calendar]]
      * [[VirtOAuthTestToolExampleFeeds][ODS Feed Manager]]
   * [[http://virtuoso.openlinksw.com/wiki/main/Main/OAuth][OpenLink's explanation of OAuth]]
   * [[http://virtuoso.openlinksw.com/wiki/main/Main/VirtuosoOAuthServer][Virtuoso OAuth server]]
   * [[VirtOAuthControllers][Using OAuth with ODS]]
   * [[VirtuosoOdsUbiquity][ODS Ubiquity Commands]]
   * [[http://virtuoso.openlinksw.com/wiki/main/Main/VirtOAuth][Virtuoso OAuth Implementation]]
   * [[VirtuosoOdsControllers][ODS Controllers]]      
   * [[VirtODSOAuthQA][Testing Virtuoso OAuth with 3rd Party OAuth Clients]]
   * [[VirtuosoOdsUbiquityTutorialsOAuth][OAuth Ubiquity Tutorial]]
   * [[http://virtuoso.openlinksw.com/wiki/main/Main/VirtOAuthSPARQL][Virtuoso SPARQL OAuth Tutorial]]
   * [[VirtuosoOdsUbiquityTutorials][ODS Ubiquity Tutorials]]
   * [[VirtOAuthExamples][OAuth Applications Authentication examples]]
   * [[http://oauth.net/core/1.0/][OAuth API]]         

CategoryAddressBook CategoryODS