New Adlib API development resources Rui Mendes Senior web - PowerPoint PPT Presentation

New Adlib API development resources Rui Mendes Senior web developer

Why new development resources? • Knowledge about the API kept internally by Adlib developers • Documentation not properly structured to be distributed to 3 rd party developers • Lack of examples on the usage of the API • Need to promote a community of Adlib API users that can help improving the API to their needs

Solutions? • Organize internal documentation • Build the API website with resources needed to develop applications on top of wwwopac.ashx • Build an API Forum to promote the formation of Adlib API Users community and create an efficient communication channel with Adlib • Provide a sandbox environment to users test the API

API website - what more could you want? • http://api.adlibsoft.com

API website • Main characteristics – Fresh design, SEO friendly, easy to use! – Content, content, content! – Built by developers for developers! • Hierarchy – Getting started – API – Downloads – Demos – Resources

Getting started • Introduction • Pointers to top areas in the website

How to search for an API Function? 1. Select a category – Search – Write – Session – Select – Lock – Session

How to search for an API Function?

How to search for an API Function? 2. Select a function and implementation type

Function description • Syntax

Function description • Live examples and source code!!

Live demos - play it! • Testable demos in the three different implementations – http://api.adlibsoft.com/demojqueryplugin/ – http://api.adlibsoft.com/demoadlibdata/ – http://api.adlibsoft.com/demourlrequest/

Demo – Simple object collections management system

Demo – Simple object collections management system • Search records

Demo – Simple object collections management system • Insert, Update and Delete records

Downloads • Client libraries – Adlib.Data dll – Adlib Jquery plugin • Demos – Visual Studio solutions with demo application for each implementation type

Resources - Sandbox environment • Users can use an online wwwopac.ashx with real data to test their applications – http://test.adlibsoft.com/adlibapi/api/wwwopac.ashx • Databases (write access) – collect.inf – externalobjects • Configuration file – adlibweb.xml – http://test.adlibsoft.com/adlibapi/api/adlibweb.xml

Resources - Sandbox environment • Test data – Content will be restored periodically – In case you need to test write commands, please create your own data records to do these tests.

Resources – Next stop, Adlib API Forum! • http://api.adlibsoft.com/forum

Adlib API Forum – Main topics • Using Adlib API – Ask questions and report issues related to using Adlib URL requests, Adlib Data.dll and jQuery Plugin • Contributions – Show your applications or share source code examples using the Adlib API • Don’t forget to sign up!