eZ Publish Community, profile picture
Uploaded byeZ Publish Community
15,533 views

Ole marius smestad - REST & PHP API : how to turn eZ Publish into a multi-channel machine

The document summarizes a presentation about developing REST APIs for eZ Publish. It discusses developing PHP APIs that are simple, consistent and predictable. It also covers the development of a REST API as a core feature for eZ Publish, with HTTP as the carrier and a dedicated front controller. The presentation outlines the initial 1.0 release of the REST API, which will focus on infrastructure and making content accessible, though it won't support full CRUD for built-in content resources until the PHP API is expanded.

Technology◦
Related topics:
Content Management•

Embed presentation

Downloaded 44 times
REST & PHP API eZ Winter Conference 2011, Nice mandag 31. januar 2011 1
Introduction 2 mandag 31. januar 2011 2
About me Ole Marius Smestad Lead engineer for eZ Publish oms@ez.no @dotten Presenter: Ole Marius Smestad 27.01.2011 3 mandag 31. januar 2011 3
Agenda Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
Agenda News and conceptual feature discussion Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
Agenda News and conceptual feature discussion What has been done Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
Agenda News and conceptual feature discussion What has been done What is being delivered Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
Agenda News and conceptual feature discussion What has been done What is being delivered How to put this work to use Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
Agenda News and conceptual feature discussion What has been done What is being delivered How to put this work to use A bit of code Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
A retrospective 5 mandag 31. januar 2011 5
A retrospective APIs Presenter: Ole Marius Smestad 27.01.2011 6 mandag 31. januar 2011 6
A retrospective PHP eZ Publish API REST Presenter: Ole Marius Smestad 27.01.2011 7 mandag 31. januar 2011 7
PHP APIs should be Simple Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
PHP APIs should be Simple Consistent Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
PHP APIs should be Simple Consistent Predictable Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
PHP APIs should be A clear relationship Presenter: Ole Marius Smestad 27.01.2011 9 mandag 31. januar 2011 9
PHP APIs should be A clear relationship Concepts Objects Tasks Presenter: Ole Marius Smestad 27.01.2011 9 mandag 31. januar 2011 9
PHP APIs should be Simple Consistent Predictable Presenter: Ole Marius Smestad 27.01.2011 10 mandag 31. januar 2011 10
PHP APIs should be Simple Consistent Predictable A stable point of reference Presenter: Ole Marius Smestad 27.01.2011 10 mandag 31. januar 2011 10
A retrospective PHP eZ Publish API REST Presenter: Ole Marius Smestad 27.01.2011 11 mandag 31. januar 2011 11
A retrospective REST Presenter: Ole Marius Smestad 27.01.2011 12 mandag 31. januar 2011 12
A retrospective REST REST Presenter: Ole Marius Smestad 27.01.2011 12 mandag 31. januar 2011 12
( ) Presenter: Ole Marius Smestad 27.01.2011 13 mandag 31. januar 2011 13
REST REST as a core feature Presenter: Ole Marius Smestad 27.01.2011 14 mandag 31. januar 2011 14
REST HTTP is the carrier Presenter: Ole Marius Smestad 27.01.2011 15 mandag 31. januar 2011 15
REST dedicated front-controller Presenter: Ole Marius Smestad 27.01.2011 16 mandag 31. januar 2011 16
REST back to the mothership Presenter: Ole Marius Smestad 27.01.2011 17 mandag 31. januar 2011 17
REST REST setup REST eZP REST  reqest FC eZ  Publish web-­‐request Presenter: Ole Marius Smestad 27.01.2011 18 mandag 31. januar 2011 18
REST REST setup REST eZP FC Presenter: Ole Marius Smestad 27.01.2011 19 mandag 31. januar 2011 19
REST mapping content into resources Presenter: Ole Marius Smestad 27.01.2011 20 mandag 31. januar 2011 20
REST Makes data available Presenter: Ole Marius Smestad 27.01.2011 21 mandag 31. januar 2011 21
REST Makes data reusable Presenter: Ole Marius Smestad 27.01.2011 21 mandag 31. januar 2011 21
REST content is liberated Presenter: Ole Marius Smestad 27.01.2011 22 mandag 31. januar 2011 22
One point oh 23 mandag 31. januar 2011 23
One point oh Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
One point oh Being released as a part of Matterhorn Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Making content accessible (in useful ways) Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Making content accessible (in useful ways) Always adaptable Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
One point oh Github repositories available today Presenter: Ole Marius Smestad 27.01.2011 25 mandag 31. januar 2011 25
One point oh – the fineprint Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
One point oh – the fineprint Wonʼt support full CRUD in 1.0 Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
One point oh – the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
One point oh – the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
One point oh – the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources REST extensions will be able to provide all operations from day one Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
One point oh – the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources REST extensions will be able to provide all operations from day one Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
Key features 27 mandag 31. januar 2011 27
Key features content resources Presenter: Ole Marius Smestad 27.01.2011 28 mandag 31. januar 2011 28
Getting node data GET /[api]/ezp/v1/content/⤦ node/<ID> HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 29 mandag 31. januar 2011 29
Getting node data Presenter: Ole Marius Smestad 27.01.2011 30 mandag 31. januar 2011 30
Getting node data classIdentifier objectName datePublished dateModified remoteID objectRemoteID nodeID objectID Full URL, etc. Presenter: Ole Marius Smestad 27.01.2011 30 mandag 31. januar 2011 30
Getting fields GET /[api]/ezp/v1/content/⤦ object/<objectId>/fields⤦ HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 31 mandag 31. januar 2011 31
Getting fields fields/<fieldname> type (datatype string) identifier (attribute identifier) value (string representation of data) id (object attribute numerical ID) classattribute_id (class attribute numerical ID) Presenter: Ole Marius Smestad 27.01.2011 32 mandag 31. januar 2011 32
Getting a specific field GET /[api]/ezp/v1/content/⤦ object/<objectId>/field/⤦ <FieldIdentifier> HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 33 mandag 31. januar 2011 33
Key features Rendered view Presenter: Ole Marius Smestad 27.01.2011 34 mandag 31. januar 2011 34
Key features Systematic URLs Response groups Other resources available child lists sorting Presenter: Ole Marius Smestad 27.01.2011 35 mandag 31. januar 2011 35
Extending the REST API 36 mandag 31. januar 2011 36
Extending REST URI pattern Presenter: Ole Marius Smestad 27.01.2011 37 mandag 31. januar 2011 37
URI pattern Just a token to trigger your rewrite rule Call + GET Host / Prefix / Provider / Version / params ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Just a token to trigger your rewrite rule Prefix Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Prefix Just a token to trigger your rewrite rule Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Prefix Just a token to trigger your rewrite rule Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
Remember, remember ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 39 mandag 31. januar 2011 39
Prefix filter Always knows Current provider Current parsed version value Presenter: Ole Marius Smestad 27.01.2011 40 mandag 31. januar 2011 40
Versioned API class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewFie new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'vie new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyContr 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); } } Presenter: Ole Marius Smestad 27.01.2011 41 mandag 31. januar 2011 41
Versioned API ezpRestVersionedRoute Presenter: Ole Marius Smestad 27.01.2011 42 mandag 31. januar 2011 42
Versioned API Version makes the notion version a part of the routing decision Presenter: Ole Marius Smestad 27.01.2011 43 mandag 31. januar 2011 43
Extending the interface REST providers Presenter: Ole Marius Smestad 27.01.2011 44 mandag 31. januar 2011 44
Extending the interface ezpRestProviderInterface Presenter: Ole Marius Smestad 27.01.2011 45 mandag 31. januar 2011 45
Extending the REST interface Overview of hooks Presenter: Ole Marius Smestad 27.01.2011 46 mandag 31. januar 2011 46
Presenter: Ole Marius Smestad 27.01.2011 47 mandag 31. januar 2011 47
Route setup 1 class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewFie new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'vie new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyContr 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); } } Presenter: Ole Marius Smestad 27.01.2011 48 mandag 31. januar 2011 48
Route setup 2 class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { $providerRoutes = ezpRestProvider::getProvider( ezpRestPrefixFilterInterface::getApiProviderName() )- >getRoutes(); $routes = array( new ezpMvcRailsRoute( '/fatal', 'ezpRestErrorController', 'show' ), new ezpMvcRailsRoute( '/http-basic-auth', 'ezpRestAuthController', 'basicAuth' ), new ezpMvcRailsRoute( '/login/oauth', 'ezpRestAuthController', 'oauthRequired' ), new ezpMvcRailsRoute( '/oauth/token', 'ezpRestOauthTokenController', 'handleRequest'), // ezpRestVersionedRoute( $route, $version ) // $version == 1 should be the same as if the only the $route had been present new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOneBetter' ), 2 ), ); return ezcMvcRouter::prefix( '/api', array_merge( $providerRoutes, $routes ) ); } } Presenter: Ole Marius Smestad 27.01.2011 49 mandag 31. januar 2011 49
Protecting your resources 50 mandag 31. januar 2011 50
Authentication OAuth 2.0 Presenter: Ole Marius Smestad 27.01.2011 51 mandag 31. januar 2011 51
Authentication Basic auth Presenter: Ole Marius Smestad 27.01.2011 52 mandag 31. januar 2011 52
Other security related options Require HTTPS (a requirement of OAuth) Decide which auth filter to use Presenter: Ole Marius Smestad 27.01.2011 53 mandag 31. januar 2011 53
Summary 54 mandag 31. januar 2011 54
Summary Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Control of BC Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Control of BC Control of already rolled out API clients Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
Questions? Presenter: Ole Marius Smestad 27.01.2011 56 mandag 31. januar 2011 56
Possibility for more Q&A at the barcamp Presenter: Ole Marius Smestad 27.01.2011 57 mandag 31. januar 2011 57
The end Thank you for listening Presenter: Ole Marius Smestad 27.01.2011 58 mandag 31. januar 2011 58
The end github.com/ezsystems/ezp_rest Presenter: Ole Marius Smestad 27.01.2011 59 mandag 31. januar 2011 59

More Related Content

PDF
No021-01-suc3rum-20110128
bySukusuku Scrum
 
PDF
Frontend caching - PHP Day, Italy, 2011
byHelgi Þormar Þorbjörnsson
 
PDF
Testing telephony
byBen Langfeld
 
PDF
Think like an ant, distribute the workload - PhpDay, Italy, 2011
byHelgi Þormar Þorbjörnsson
 
PDF
The Digital Toolbox - a discussion -Science Online '11
byKaitlin Thaney
 
ODP
eZ Publish Asynchronous Content Publishing
byBertrand Dunogier
 
PPTX
Taxonomy management in eZ Publish, the new eZ Tags datatype
byIvo Lukač
 
PDF
2012-11-30-scalable game servers
byWooga
 
No021-01-suc3rum-20110128
bySukusuku Scrum
 
Frontend caching - PHP Day, Italy, 2011
byHelgi Þormar Þorbjörnsson
 
Testing telephony
byBen Langfeld
 
Think like an ant, distribute the workload - PhpDay, Italy, 2011
byHelgi Þormar Þorbjörnsson
 
The Digital Toolbox - a discussion -Science Online '11
byKaitlin Thaney
 
eZ Publish Asynchronous Content Publishing
byBertrand Dunogier
 
Taxonomy management in eZ Publish, the new eZ Tags datatype
byIvo Lukač
 
2012-11-30-scalable game servers
byWooga
 

More from eZ Publish Community

PPTX
5 idées pour transformer votre contenu en business
byeZ Publish Community
 
PPTX
eZ Publish Plateform 5.2 Webinar Deutsch
byeZ Publish Community
 
PDF
eZ UnConference#2 - eZ Publish 5 basics Philippe Vincent-Royol & Florent Huck
byeZ Publish Community
 
PDF
eZ Unconference#2 - Future of the internet 2020 - C. Zahneissen (cpo)
byeZ Publish Community
 
PDF
eZ Unconference#2 - Keynote - A. Farstad (CEO)
byeZ Publish Community
 
PDF
2013.04.23 eZ Sessions 6 - Migrating legacy eZ Publish extensions - Lukasz Se...
byeZ Publish Community
 
PDF
Cxm mobile stig martin fiska
byeZ Publish Community
 
PPTX
App factory igor vrdoljak
byeZ Publish Community
 
DOCX
The administration interface
byeZ Publish Community
 
RTF
How is the 5.x data model going to compare to 4.x (+no sql )
byeZ Publish Community
 
TXT
Handling transition between 4.x and 5.x.
byeZ Publish Community
 
DOCX
E z publish 5 template syntax (twig),
byeZ Publish Community
 
PPTX
2012 10-17 un conference ez publish cloud presentation
byeZ Publish Community
 
PDF
Mugo - Approval Workflow extension for eZ Publish - eZ Day Paris - Oct 14th 2011
byeZ Publish Community
 
PPTX
Tony Wood - Keynote Vision with Technology
byeZ Publish Community
 
PPT
Simon Wan - Keynote - The Web Strategy of the Wall Street Journal in Asia
byeZ Publish Community
 
PDF
Maxime Thomas - eZBK
byeZ Publish Community
 
PDF
Mark Marsiglio - Autoscaling with eZ in the Cloud - A Case Study
byeZ Publish Community
 
PPTX
Marianne Otterdahl Møller - Multinational and multichannel market communication
byeZ Publish Community
 
PPTX
Gabriele Viebach - Keynote eZ Conference
byeZ Publish Community
 
5 idées pour transformer votre contenu en business
byeZ Publish Community
 
eZ Publish Plateform 5.2 Webinar Deutsch
byeZ Publish Community
 
eZ UnConference#2 - eZ Publish 5 basics Philippe Vincent-Royol & Florent Huck
byeZ Publish Community
 
eZ Unconference#2 - Future of the internet 2020 - C. Zahneissen (cpo)
byeZ Publish Community
 
eZ Unconference#2 - Keynote - A. Farstad (CEO)
byeZ Publish Community
 
2013.04.23 eZ Sessions 6 - Migrating legacy eZ Publish extensions - Lukasz Se...
byeZ Publish Community
 
Cxm mobile stig martin fiska
byeZ Publish Community
 
App factory igor vrdoljak
byeZ Publish Community
 
The administration interface
byeZ Publish Community
 
How is the 5.x data model going to compare to 4.x (+no sql )
byeZ Publish Community
 
Handling transition between 4.x and 5.x.
byeZ Publish Community
 
E z publish 5 template syntax (twig),
byeZ Publish Community
 
2012 10-17 un conference ez publish cloud presentation
byeZ Publish Community
 
Mugo - Approval Workflow extension for eZ Publish - eZ Day Paris - Oct 14th 2011
byeZ Publish Community
 
Tony Wood - Keynote Vision with Technology
byeZ Publish Community
 
Simon Wan - Keynote - The Web Strategy of the Wall Street Journal in Asia
byeZ Publish Community
 
Maxime Thomas - eZBK
byeZ Publish Community
 
Mark Marsiglio - Autoscaling with eZ in the Cloud - A Case Study
byeZ Publish Community
 
Marianne Otterdahl Møller - Multinational and multichannel market communication
byeZ Publish Community
 
Gabriele Viebach - Keynote eZ Conference
byeZ Publish Community
 

Recently uploaded

PDF
Day 3 - Data and Application Security - 2nd Sight Lab Cloud Security Class
by2nd Sight Lab
 
PDF
Accelerating Responsible AI Adoption in Public Sector and Private Organizations.
byYasir Naveed Riaz
 
PDF
Safeguarding AI-Based Financial Infrastructure
byYasir Naveed Riaz
 
PDF
API-First Architecture in Financial Systems
bycyy111112
 
PDF
The year in review - MarvelClient in 2025
bypanagenda
 
PDF
Unlocking the Power of Salesforce Architecture: Frameworks for Effective Solu...
byvarsha30tiwari
 
PDF
Session 1 - Solving Semi-Structured Documents with Document Understanding
byDianaGray10
 
PPTX
Data Privacy and Protection: Safeguarding Information in a Connected World
byYasir Naveed Riaz
 
PDF
Day 2 - Network Security ~ 2nd Sight Lab ~ Cloud Security Class ~ 2020
by2nd Sight Lab
 
PDF
GPUS and How to Program Them by Manya Bansal
byScyllaDB
 
PDF
Usage Control for Process Discovery through a Trusted Execution Environment
byValerioGoretti
 
PDF
Is It Possible to Have Wi-Fi Without an Internet Provider
bySidra Jefferi
 
PDF
Making Sense of Raster: From Bit Depth to Better Workflows
bySafe Software
 
PDF
Day 1 - Cloud Security Strategy and Planning ~ 2nd Sight Lab ~ Cloud Security...
by2nd Sight Lab
 
PDF
Energy Storage Landscape Clean Energy Ministerial
bySurajitBanerjee38
 
PPTX
AI in Cybersecurity: Digital Defense by Yasir Naveed Riaz
byYasir Naveed Riaz
 
PDF
Security Technologys: Access Control, Firewall, VPN
byShielaLasala
 
PPTX
THIS IS CYBER SECURITY NOTES USED IN CLASS ON VARIOUS TOPICS USED IN CYBERSEC...
byMelissaGblinwon
 
PPTX
Cybercrime in the Digital Age: Risks, Impact & Protection
byYasir Naveed Riaz
 
PDF
Vibe Coding vs. Spec-Driven Development [Free Meetup]
byHaim Michael
 
Day 3 - Data and Application Security - 2nd Sight Lab Cloud Security Class
by2nd Sight Lab
 
Accelerating Responsible AI Adoption in Public Sector and Private Organizations.
byYasir Naveed Riaz
 
Safeguarding AI-Based Financial Infrastructure
byYasir Naveed Riaz
 
API-First Architecture in Financial Systems
bycyy111112
 
The year in review - MarvelClient in 2025
bypanagenda
 
Unlocking the Power of Salesforce Architecture: Frameworks for Effective Solu...
byvarsha30tiwari
 
Session 1 - Solving Semi-Structured Documents with Document Understanding
byDianaGray10
 
Data Privacy and Protection: Safeguarding Information in a Connected World
byYasir Naveed Riaz
 
Day 2 - Network Security ~ 2nd Sight Lab ~ Cloud Security Class ~ 2020
by2nd Sight Lab
 
GPUS and How to Program Them by Manya Bansal
byScyllaDB
 
Usage Control for Process Discovery through a Trusted Execution Environment
byValerioGoretti
 
Is It Possible to Have Wi-Fi Without an Internet Provider
bySidra Jefferi
 
Making Sense of Raster: From Bit Depth to Better Workflows
bySafe Software
 
Day 1 - Cloud Security Strategy and Planning ~ 2nd Sight Lab ~ Cloud Security...
by2nd Sight Lab
 
Energy Storage Landscape Clean Energy Ministerial
bySurajitBanerjee38
 
AI in Cybersecurity: Digital Defense by Yasir Naveed Riaz
byYasir Naveed Riaz
 
Security Technologys: Access Control, Firewall, VPN
byShielaLasala
 
THIS IS CYBER SECURITY NOTES USED IN CLASS ON VARIOUS TOPICS USED IN CYBERSEC...
byMelissaGblinwon
 
Cybercrime in the Digital Age: Risks, Impact & Protection
byYasir Naveed Riaz
 
Vibe Coding vs. Spec-Driven Development [Free Meetup]
byHaim Michael
 

Ole marius smestad - REST & PHP API : how to turn eZ Publish into a multi-channel machine

  • 1.
    REST & PHPAPI eZ Winter Conference 2011, Nice mandag 31. januar 2011 1
  • 2.
    Introduction 2 mandag 31. januar 2011 2
  • 3.
    About me Ole Marius Smestad Lead engineer for eZ Publish oms@ez.no @dotten Presenter: Ole Marius Smestad 27.01.2011 3 mandag 31. januar 2011 3
  • 4.
    Agenda Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 5.
    Agenda News and conceptual feature discussion Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 6.
    Agenda News and conceptual feature discussion What has been done Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 7.
    Agenda News and conceptual feature discussion What has been done What is being delivered Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 8.
    Agenda News and conceptual feature discussion What has been done What is being delivered How to put this work to use Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 9.
    Agenda News and conceptual feature discussion What has been done What is being delivered How to put this work to use A bit of code Presenter: Ole Marius Smestad 27.01.2011 4 mandag 31. januar 2011 4
  • 10.
    A retrospective 5 mandag 31. januar 2011 5
  • 11.
    A retrospective APIs Presenter: Ole Marius Smestad 27.01.2011 6 mandag 31. januar 2011 6
  • 12.
    A retrospective PHP eZ Publish API REST Presenter: Ole Marius Smestad 27.01.2011 7 mandag 31. januar 2011 7
  • 13.
    PHP APIs shouldbe Simple Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
  • 14.
    PHP APIs shouldbe Simple Consistent Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
  • 15.
    PHP APIs shouldbe Simple Consistent Predictable Presenter: Ole Marius Smestad 27.01.2011 8 mandag 31. januar 2011 8
  • 16.
    PHP APIs shouldbe A clear relationship Presenter: Ole Marius Smestad 27.01.2011 9 mandag 31. januar 2011 9
  • 17.
    PHP APIs shouldbe A clear relationship Concepts Objects Tasks Presenter: Ole Marius Smestad 27.01.2011 9 mandag 31. januar 2011 9
  • 18.
    PHP APIs shouldbe Simple Consistent Predictable Presenter: Ole Marius Smestad 27.01.2011 10 mandag 31. januar 2011 10
  • 19.
    PHP APIs shouldbe Simple Consistent Predictable A stable point of reference Presenter: Ole Marius Smestad 27.01.2011 10 mandag 31. januar 2011 10
  • 20.
    A retrospective PHP eZ Publish API REST Presenter: Ole Marius Smestad 27.01.2011 11 mandag 31. januar 2011 11
  • 21.
    A retrospective REST Presenter: Ole Marius Smestad 27.01.2011 12 mandag 31. januar 2011 12
  • 22.
    A retrospective REST REST Presenter: Ole Marius Smestad 27.01.2011 12 mandag 31. januar 2011 12
  • 23.
    ( ) Presenter: Ole Marius Smestad 27.01.2011 13 mandag 31. januar 2011 13
  • 24.
    REST REST as a core feature Presenter: Ole Marius Smestad 27.01.2011 14 mandag 31. januar 2011 14
  • 25.
    REST HTTP is the carrier Presenter: Ole Marius Smestad 27.01.2011 15 mandag 31. januar 2011 15
  • 26.
    REST dedicated front-controller Presenter: Ole Marius Smestad 27.01.2011 16 mandag 31. januar 2011 16
  • 27.
    REST back to the mothership Presenter: Ole Marius Smestad 27.01.2011 17 mandag 31. januar 2011 17
  • 28.
    REST REST setup REST eZP REST  reqest FC eZ  Publish web-­‐request Presenter: Ole Marius Smestad 27.01.2011 18 mandag 31. januar 2011 18
  • 29.
    REST REST setup REST eZP FC Presenter: Ole Marius Smestad 27.01.2011 19 mandag 31. januar 2011 19
  • 30.
    REST mapping content into resources Presenter: Ole Marius Smestad 27.01.2011 20 mandag 31. januar 2011 20
  • 31.
    REST Makes data available Presenter: Ole Marius Smestad 27.01.2011 21 mandag 31. januar 2011 21
  • 32.
    REST Makes data reusable Presenter: Ole Marius Smestad 27.01.2011 21 mandag 31. januar 2011 21
  • 33.
    REST content is liberated Presenter: Ole Marius Smestad 27.01.2011 22 mandag 31. januar 2011 22
  • 34.
    One point oh 23 mandag 31. januar 2011 23
  • 35.
    One point oh Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
  • 36.
    One point oh Being released as a part of Matterhorn Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
  • 37.
    One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
  • 38.
    One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Making content accessible (in useful ways) Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
  • 39.
    One point oh Being released as a part of Matterhorn Focus on infrastructure and basics Making content accessible (in useful ways) Always adaptable Presenter: Ole Marius Smestad 27.01.2011 24 mandag 31. januar 2011 24
  • 40.
    One point oh Github repositories available today Presenter: Ole Marius Smestad 27.01.2011 25 mandag 31. januar 2011 25
  • 41.
    One point oh– the fineprint Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 42.
    One point oh– the fineprint Wonʼt support full CRUD in 1.0 Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 43.
    One point oh– the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 44.
    One point oh– the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 45.
    One point oh– the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources REST extensions will be able to provide all operations from day one Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 46.
    One point oh– the fineprint Wonʼt support full CRUD in 1.0 Waiting for additions to our PHP API to fully support this Applies to built-in content resources REST extensions will be able to provide all operations from day one Presenter: Ole Marius Smestad 27.01.2011 26 mandag 31. januar 2011 26
  • 47.
    Key features 27 mandag 31. januar 2011 27
  • 48.
    Key features content resources Presenter: Ole Marius Smestad 27.01.2011 28 mandag 31. januar 2011 28
  • 49.
    Getting node data GET /[api]/ezp/v1/content/⤦ node/<ID> HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 29 mandag 31. januar 2011 29
  • 50.
    Getting node data Presenter: Ole Marius Smestad 27.01.2011 30 mandag 31. januar 2011 30
  • 51.
    Getting node data classIdentifier objectName datePublished dateModified remoteID objectRemoteID nodeID objectID Full URL, etc. Presenter: Ole Marius Smestad 27.01.2011 30 mandag 31. januar 2011 30
  • 52.
    Getting fields GET /[api]/ezp/v1/content/⤦ object/<objectId>/fields⤦ HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 31 mandag 31. januar 2011 31
  • 53.
    Getting fields fields/<fieldname> type (datatype string) identifier (attribute identifier) value (string representation of data) id (object attribute numerical ID) classattribute_id (class attribute numerical ID) Presenter: Ole Marius Smestad 27.01.2011 32 mandag 31. januar 2011 32
  • 54.
    Getting a specificfield GET /[api]/ezp/v1/content/⤦ object/<objectId>/field/⤦ <FieldIdentifier> HTTP/1.1 Presenter: Ole Marius Smestad 27.01.2011 33 mandag 31. januar 2011 33
  • 55.
    Key features Rendered view Presenter: Ole Marius Smestad 27.01.2011 34 mandag 31. januar 2011 34
  • 56.
    Key features Systematic URLs Response groups Other resources available child lists sorting Presenter: Ole Marius Smestad 27.01.2011 35 mandag 31. januar 2011 35
  • 57.
    Extending the RESTAPI 36 mandag 31. januar 2011 36
  • 58.
    Extending REST URI pattern Presenter: Ole Marius Smestad 27.01.2011 37 mandag 31. januar 2011 37
  • 59.
    URI pattern Just a token to trigger your rewrite rule Call + GET Host / Prefix / Provider / Version / params ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 60.
    URI pattern Just a token to trigger your rewrite rule Prefix Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 61.
    URI pattern Prefix Just a token to trigger your rewrite rule Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 62.
    URI pattern Prefix Just a token to trigger your rewrite rule Provider Version ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 63.
    URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 64.
    URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 65.
    URI pattern Prefix Just a token to trigger your rewrite rule Provider ezpRestPrefixFilterInterface Version Presenter: Ole Marius Smestad 27.01.2011 38 mandag 31. januar 2011 38
  • 66.
    Remember, remember ezpRestPrefixFilterInterface Presenter: Ole Marius Smestad 27.01.2011 39 mandag 31. januar 2011 39
  • 67.
    Prefix filter Always knows Current provider Current parsed version value Presenter: Ole Marius Smestad 27.01.2011 40 mandag 31. januar 2011 40
  • 68.
    Versioned API class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewFie new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'vie new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyContr 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); } } Presenter: Ole Marius Smestad 27.01.2011 41 mandag 31. januar 2011 41
  • 69.
    Versioned API ezpRestVersionedRoute Presenter: Ole Marius Smestad 27.01.2011 42 mandag 31. januar 2011 42
  • 70.
    Versioned API Version makes the notion version a part of the routing decision Presenter: Ole Marius Smestad 27.01.2011 43 mandag 31. januar 2011 43
  • 71.
    Extending the interface REST providers Presenter: Ole Marius Smestad 27.01.2011 44 mandag 31. januar 2011 44
  • 72.
    Extending the interface ezpRestProviderInterface Presenter: Ole Marius Smestad 27.01.2011 45 mandag 31. januar 2011 45
  • 73.
    Extending the RESTinterface Overview of hooks Presenter: Ole Marius Smestad 27.01.2011 46 mandag 31. januar 2011 46
  • 74.
    Presenter: Ole MariusSmestad 27.01.2011 47 mandag 31. januar 2011 47
  • 75.
    Route setup 1 class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { // ezpRestApiProvider $routes = array( new ezcMvcRailsRoute( '/content/node/:nodeId/listAtom', 'ezpRestAtomController', 'collection' ), new ezcMvcRailsRoute( '/content/node/:nodeId/list', 'ezpRestContentController', 'list' ), new ezcMvcRailsRoute( '/content/node/:nodeId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/node/:nodeId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/node/:nodeId/field/:fieldIdentifier', 'ezpRestContentController', 'viewFie new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ), new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController', 'viewFields' ), new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier', 'ezpRestContentController', 'vie new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo', 'myController2 or myControlerWhichExtendsmyContr 'myBetterAndScalingAction' ), 2 ), ); return ezcMvcRouter::prefix( '/api', $routes ); } } Presenter: Ole Marius Smestad 27.01.2011 48 mandag 31. januar 2011 48
  • 76.
    Route setup 2 class ezpRestRouter extends ezcMvcRouter { public function createRoutes() { $providerRoutes = ezpRestProvider::getProvider( ezpRestPrefixFilterInterface::getApiProviderName() )- >getRoutes(); $routes = array( new ezpMvcRailsRoute( '/fatal', 'ezpRestErrorController', 'show' ), new ezpMvcRailsRoute( '/http-basic-auth', 'ezpRestAuthController', 'basicAuth' ), new ezpMvcRailsRoute( '/login/oauth', 'ezpRestAuthController', 'oauthRequired' ), new ezpMvcRailsRoute( '/oauth/token', 'ezpRestOauthTokenController', 'handleRequest'), // ezpRestVersionedRoute( $route, $version ) // $version == 1 should be the same as if the only the $route had been present new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ), new ezpRestVersionedRoute( new ezpMvcRailsRoute( '/foo', 'myController', 'myActionOneBetter' ), 2 ), ); return ezcMvcRouter::prefix( '/api', array_merge( $providerRoutes, $routes ) ); } } Presenter: Ole Marius Smestad 27.01.2011 49 mandag 31. januar 2011 49
  • 77.
    Protecting your resources 50 mandag 31. januar 2011 50
  • 78.
    Authentication OAuth 2.0 Presenter: Ole Marius Smestad 27.01.2011 51 mandag 31. januar 2011 51
  • 79.
    Authentication Basic auth Presenter: Ole Marius Smestad 27.01.2011 52 mandag 31. januar 2011 52
  • 80.
    Other security relatedoptions Require HTTPS (a requirement of OAuth) Decide which auth filter to use Presenter: Ole Marius Smestad 27.01.2011 53 mandag 31. januar 2011 53
  • 81.
    Summary 54 mandag 31. januar 2011 54
  • 82.
    Summary Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 83.
    Summary Comes with the next release Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 84.
    Summary Comes with the next release Gives access to existing content in a systematic way Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 85.
    Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 86.
    Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 87.
    Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 88.
    Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Control of BC Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 89.
    Summary Comes with the next release Gives access to existing content in a systematic way Output of content can be tweaked Is extendible through eZ Market extensions API is versioned Control of BC Control of already rolled out API clients Presenter: Ole Marius Smestad 27.01.2011 55 mandag 31. januar 2011 55
  • 90.
    Questions? Presenter: Ole Marius Smestad 27.01.2011 56 mandag 31. januar 2011 56
  • 91.
    Possibility for moreQ&A at the barcamp Presenter: Ole Marius Smestad 27.01.2011 57 mandag 31. januar 2011 57
  • 92.
    The end Thank you for listening Presenter: Ole Marius Smestad 27.01.2011 58 mandag 31. januar 2011 58
  • 93.
    The end github.com/ezsystems/ezp_rest Presenter: Ole Marius Smestad 27.01.2011 59 mandag 31. januar 2011 59