1. Launching
content in
mobility with
REST &
eZ Publish

2. Launching
content in
mobility with
REST &
eZ Publish
Nicolas Pastorino - nfrp@ez.no
Director Community - eZ Systems
@jeanvoye - http://share.ez.no

3. #ipcse11
Launching
content in
mobility with
Mobile
REST &
International PHP Conference, SE 2011 - Berlin - May 30th
eZ Publish
Nicolas Pastorino - nfrp@ez.no
Director Community - eZ Systems
@jeanvoye - http://share.ez.no

4. #ipcse11
Launching
content in
mobility with
Mobile
REST &
International PHP Conference, SE 2011 - Berlin - May 30th
eZ Publish
Nicolas Pastorino - nfrp@ez.no
Director Community - eZ Systems
@jeanvoye - http://share.ez.no

5. Our agenda :

6. Our agenda :
Multichannel : why ?

7. Our agenda :
Multichannel : why ?
REST

8. Our agenda :
Multichannel : why ?
REST
Extensible REST API

9. Our agenda :
Multichannel : why ?
REST
Extensible REST API
Demo

10. Multichannel : why ?
3

12. How would you
feel playing
Pacman on a
single, straight line
of dots ?

13. How would you
feel playing
Pacman on a
single, straight line
of dots ?

14. How would you
feel playing
Boring,
Pacman on a
right ? line
single, straight
of dots ?

16. Multichannel
content
distribution is
the real Pacman

17. Multichannel
content
distribution is
the real Pacman

19. Pre-requisites to multichannel distribution
Nicolas Pastorino - IPCse11 30/05/2011 7

20. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
Nicolas Pastorino - IPCse11 30/05/2011 7

21. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
Nicolas Pastorino - IPCse11 30/05/2011 7

22. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
Do not compromise on
user experience 2
Nicolas Pastorino - IPCse11 30/05/2011 7

23. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
“The Superman Effect” Aral Balkan, DPC11
Do not compromise on
user experience 2
Nicolas Pastorino - IPCse11 30/05/2011 7

24. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
“The Superman Effect” Aral Balkan, DPC11
Do not compromise on
user experience 2
“There is a lot of effort going into improving
customer experience. It is key to get
consistency across different channels so their
experience does not vary” Jim Daviesni
Nicolas Pastorino - IPCse11 30/05/2011 7

25. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
“The Superman Effect” Aral Balkan, DPC11
Do not compromise on
user experience 2
“There is a lot of effort going into improving
customer experience. It is key to get
consistency across different channels so their
Have a single source experience does not vary” Jim Daviesni
of content 3
Nicolas Pastorino - IPCse11 30/05/2011 7

26. Pre-requisites to multichannel distribution
Separation of layout
and content at the 1
content source level
“The Superman Effect” Aral Balkan, DPC11
Do not compromise on
user experience 2
“There is a lot of effort going into improving
customer experience. It is key to get
consistency across different channels so their
Have a single source experience does not vary” Jim Daviesni
of content 3
“Publishers usually can't afford a dedicated
editorial team per channel”
Nicolas Pastorino - IPCse11 30/05/2011 7

28. Are 3
rules of
thumb
enough
?

29. Are 3
rules of
thumb
enough
We’re
? hardly
off the
ground.
Let’s dig
further...

30. Single
Content
Source / CMS

31. Single
Content
Source / CMS

32. Monetized
Content
Streams
Single
Content
Source / CMS

33. Monetized
Content
Streams
Mobile
Applications
Single
/
Smartphones, Tablets
Content
Source
CMS

34. Monetized
Content
Streams
Mobile
Applications
Single
/
Smartphones, Tablets
Content
Source
CMS Push 3rd party
CRM, ERP
Content
Newsletters

35. Monetized
Content
Streams
Mobile
Applications
Single
/
Smartphones, Tablets
Content
Source
CMS Push 3rd party
CRM, ERP
Content
Newsletters
Print
Legacy publication chains

36. Monetized
Content
Streams
Mobile
Applications
Single
/
Smartphones, Tablets
Content
Source
CMS Push 3rd party
CRM, ERP
Content
Newsletters
Print
Legacy publication chains
Social Media

38. "Multichannel media consumers have higher levels
of engagement than those present in only one
channel.
The more one watches TV, listens to the radio,
spends time online, etc., the more advertising they
consume.
This shows that multichannel content
distribution will also have an important impact
on the publishers revenue structure. It will
evolve to become a competitive, critical, enabling
technology for marketing communications."

40. Having a
REST ?
:)

41. Having a
REST ?
:)
A touch
more of
insight will
help...

43. “Media companies as well as consumer brands must
recognize that adding mobile to the multichannel mix
does not mean creating a mini-channel. Those
building mobile strategies should recognize that:
• Mobile is not just about shrinking the
desktop experience,
• The user environment is an element of the
mobile experience,
• Mobile users are not simply a subset of
online users – some are new.”

45. Least
Common
Denominator :

46. Least
Common
Denominator :
a REST API

48. Those
were the
basics to
increase
your
REACH
through
multiple
channels

49. REST
15

50. REpresentational
State
Transfer

51. REpresentational
State
Transfer
REST is a set of principles that define how Web standards, such as
HTTP and URIs, are supposed to be used.
• Give every “thing” an ID
• Link things together (“HATEOAS”)
• Use standard methods
• Resources with multiple representations
• Communicate statelessly

52. REpresentational
State
Transfer
REST is a set of principles that define how Web standards, such as
HTTP and URIs, are supposed to be used.
• Give every “thing” an ID
• Link things together (“HATEOAS”)
• Use standard methods
• Resources with multiple representations
• Communicate statelessly
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

53. REpresentational
State
Transfer
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

54. REpresentational
State
Transfer
Key goals of REST include:
• Scalability of component interactions
• Generality of interfaces
• Independent deployment of components
• Intermediary components to reduce latency, enforce security and
encapsulate legacy systems
h"p://www.infoq.com/ar4cles/rest-­‐introduc4on
h"p://en.wikipedia.org/wiki/Representa4onal_State_Transfer

55. Extensible REST API
at the core of the eZ Publish CMS
18

56. At the core of the eZ Publish CMS
Extensible REST API
REST as a core feature
Nicolas Pastorino - IPCse11 30/05/2011 19

57. At the core of the eZ Publish CMS
Extensible REST API
Dedicated front-controller
Nicolas Pastorino - IPCse11 30/05/2011 20

58. At the core of the eZ Publish CMS
Extensible REST API
REST setup
REST
eZP
REST
request
FC
eZ
Publish
web-­‐request
Nicolas Pastorino - IPCse11 30/05/2011 21

59. At the core of the eZ Publish CMS
Extensible REST API
REST setup
REST
eZP
REST
request
FC
eZ
Publish
web-­‐request
Nicolas Pastorino - IPCse11 30/05/2011 21

60. At the core of the eZ Publish CMS
Extensible REST API
Mapping content into
resources
Nicolas Pastorino - IPCse11 30/05/2011 22

61. At the core of the eZ Publish CMS
Extensible REST API
Makes data available
Nicolas Pastorino - IPCse11 30/05/2011 23

62. At the core of the eZ Publish CMS
Extensible REST API
Makes data reusable
Nicolas Pastorino - IPCse11 30/05/2011 23

63. At the core of the eZ Publish CMS
Extensible REST API
Content is essentially
liberated
Nicolas Pastorino - IPCse11 30/05/2011 24

64. At the core of the eZ Publish CMS
Extensible REST API
URI pattern
Nicolas Pastorino - IPCse11 30/05/2011 25

65. At the core of the eZ Publish CMS
Extensible REST API
Just a token to trigger your rewrite rule
Call +
GET Host / Prefix / Provider / Version / params
ezpRestPrefixFilterInterface
Nicolas Pastorino - IPCse11 30/05/2011 26

66. At the core of the eZ Publish CMS
Extensible REST API
Prefix Just a token to trigger your rewrite rule
Provider
ezpRestPrefixFilterInterface
Version
Nicolas Pastorino - IPCse11 30/05/2011 26

67. At the core of the eZ Publish CMS
Extensible REST API
Prefix Just a token to trigger your rewrite rule
Provider
ezpRestPrefixFilterInterface
Version
Nicolas Pastorino - IPCse11 30/05/2011 26

68. At the core of the eZ Publish CMS
Extensible REST API
Prefix Just a token to trigger your rewrite rule
Provider
ezpRestPrefixFilterInterface
Version
Nicolas Pastorino - IPCse11 30/05/2011 26

69. Prefix filter
ezpRestPrefixFilterInterface
Current provider
Current parsed version value
Nicolas Pastorino - IPCse11 30/05/2011 27

70. 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', 'viewField' ),
new ezcMvcRailsRoute( '/content/object/:objectId', 'ezpRestContentController', 'viewContent' ),
new ezcMvcRailsRoute( '/content/object/:objectId/fields', 'ezpRestContentController',
'viewFields' ),
new ezcMvcRailsRoute( '/content/object/:objectId/field/:fieldIdentifier',
'ezpRestContentController', 'viewField' ),
new ezpRestVersionedRoute( new ezcMvcRailsRoute( '/foo', 'myController', 'myActionOne' ), 1 ),
new ezpRestVersionedRoute( new ezcMvcRailsRoute( 'e/foo',
'myController2 or myControlerWhichExtendsmyController',
'myBetterAndScalingAction' ), 2 ),
);
return ezcMvcRouter::prefix( '/api', $routes );
}
} Nicolas Pastorino - IPCse11 30/05/2011 28

71. Versioned API
ezpRestVersionedRoute
Version
makes the notion version a
part of the routing decision
Nicolas Pastorino - IPCse11 30/05/2011 29

72. At the core of the eZ Publish CMS
Extensible REST API
Build your own flavor,
extend the interface(s)
Nicolas Pastorino - IPCse11 30/05/2011 30

73. Extending the interface
REST providers
Nicolas Pastorino - IPCse11 30/05/2011 31

74. Extending the interface
ezpRestProviderInterface
Nicolas Pastorino - IPCse11 30/05/2011 32

75. Overview of hooks
the places where you can go wild.

76. Nicolas Pastorino - IPCse11 30/05/2011 34

77. Route setup - Example
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 ) );
}
}
Nicolas Pastorino - IPCse11 30/05/2011 35

78. Extensible REST API
Key features
36

79. Key features
Extensible REST API
Content resources
Nicolas Pastorino - IPCse11 30/05/2011 37

80. Key features
GET /[api]/v1/content/object/
<objectId>/fields HTTP/1.1
Nicolas Pastorino - IPCse11 30/05/2011 38

81. Key features
fields/<fieldname>
type (datatype string)
identifier (attribute identifier)
value (string representation of data)
id (object attribute numerical ID)
classattribute_id (class attribute numerical ID)
Nicolas Pastorino - IPCse11 30/05/2011 39

82. Key features
GET /[api]/v1/content/object/
<objectId>/field/
<FieldIdentifier> HTTP/1.1
Nicolas Pastorino - IPCse11 30/05/2011 40

83. Demo
Web + Android, eZ Publish powered
41

84. Famous Last Slides
42

85. RECAP
Multichannel : why ?
REST
Extensible REST API
Demo

87. You won’t ever
play Pacman
the same way
again :)

88. You won’t ever
play Pacman
the same way
again :)

89. You won’t ever
play Pacman
the same way
again :)

90. Find me on Twitter : @jeanvoye
Rate this talk : http://joind.in/3482
Slides available soon at http://slideshare.net/jeanvoye
eZ Conference, June 16th&17th, London :
Rasmus Lerdorf,
Derick Rethans,
Tobias Schlitt
Get a 20% off coupon at the eZ booth in the hall, and register :
http://london2011.ez.no
eZ Community
http://share.ez.no
eZ Publish Community Project
https://github.com/ezsystems/ezpublish
Thank you !
http://share.ez.no/download
http://share.ez.no/get-involved
eZ Systems & eZ Publish Enterprise Edition
http://ez.no