Weblog 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 weblog.post.new and weblog.post.get using the OAuth Test Tool. Full list of the ODS REST APIs for ODS Weblog 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 Weblog instance or create such in not existing. For ex.: 150fd483a3219e09847676deebae6c725d5a0a03
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: 150fd483a3219e09847676deebae6c725d5a0a03
   3. API method: weblog.post.new
   4. API parameters:
      

      
      inst_id=44&description=my test&title=my first post
      

      
      
      • 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%20Weblog"
        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>44</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 Weblog
        

        
        
   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 post will be: 37
   • 
10. Now lets get the data for the created post. In the form enter:
    1. API method: weblog.get
    2. API parameters: post_id=37
    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 posts with the given above id.
    • 

Related

• Weblog REST Controllers
• OAuth Test Tool for ODS Controllers - Examples:
  • ODS Briefcase
  • ODS Addressbook
  • ODS Bookmarks
  • ODS Polls
  • ODS Calendar
  • ODS Feed Manager
• OpenLink's explanation of OAuth
• Virtuoso OAuth server
• Using OAuth with ODS
• ODS Ubiquity Commands
• Virtuoso OAuth Implementation
• ODS Controllers
• Testing Virtuoso OAuth with 3rd Party OAuth Clients
• OAuth Ubiquity Tutorial
• Virtuoso SPARQL OAuth Tutorial
• ODS Ubiquity Tutorials
• OAuth Applications Authentication examples
• OAuth API

CategoryBlog CategoryODS