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

▶
new adlib api development resources
SMART_READER_LITE
LIVE PREVIEW

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

Apr 21, 2023 147 likes •366 views

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

slide-1
SLIDE 1

New Adlib API development resources

Rui Mendes Senior web developer

slide-2
SLIDE 2

Why new development resources?

  • Knowledge about the API kept internally

by Adlib developers

  • Documentation not properly structured to

be distributed to 3rd 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

slide-3
SLIDE 3

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

slide-4
SLIDE 4

API website - what more could you want?

  • http://api.adlibsoft.com
slide-5
SLIDE 5

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

slide-6
SLIDE 6

Getting started

  • Introduction
  • Pointers to top areas in the website
slide-7
SLIDE 7

How to search for an API Function?

  • 1. Select a category

– Search – Write – Session – Select – Lock – Session

slide-8
SLIDE 8

How to search for an API Function?

slide-9
SLIDE 9

How to search for an API Function?

  • 2. Select a function and implementation type
slide-10
SLIDE 10

Function description

  • Syntax
slide-11
SLIDE 11

Function description

  • Live examples and source code!!
slide-12
SLIDE 12

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/

slide-13
SLIDE 13

Demo – Simple object collections management system

slide-14
SLIDE 14

Demo – Simple object collections management system

  • Search records
slide-15
SLIDE 15

Demo – Simple object collections management system

  • Insert, Update and Delete records
slide-16
SLIDE 16

Downloads

  • Client libraries

– Adlib.Data dll – Adlib Jquery plugin

  • Demos

– Visual Studio solutions with demo application for each implementation type

slide-17
SLIDE 17

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

slide-18
SLIDE 18

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.

slide-19
SLIDE 19

Resources – Next stop, Adlib API Forum!

  • http://api.adlibsoft.com/forum
slide-20
SLIDE 20

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!