Alfresco 5.2 Introduces New Public REST APIs
For an update, please see: https://www.slideshare.net/jvonka/exciting-new-alfresco-apis
https://www.meetup.com/Alfresco-Meetups/events/236987848/
An overview of the new and enhanced APIs will be discussed and some of the key endpoints demonstrated via Postman so that by the time you leave you should have enough knowledge to create a simple client or integration.
These APIs will also be the foundation for new clients developed for the Alfresco Digital Business Platform.
We'll have a sneak peek at what's coming next and leave plenty of time for questions, feedback and open discussion.
6. Alfresco Digital Business Platform
Applications – Engaging UX - Mobile, Web, App Dev Framework, Desktop
Alfresco Process
Services
Alfresco Content
Services
Alfresco Governance Services
Integrations / Extensions
Open APIs and Open Standards
On-Premise, Cloud, Hybrid, Managed
Intelligence and Analytics
9. REST API Introduction
• REST Framework
– pragmatic, follows well-defined RESTful guidelines
• Open API
– consistent, documented, functional, performant, secure, reliable …
• The API for all new clients
– enabler for Alfresco Digital Business Platform
• Roles
– End-User vs Administrators
– permissions – Groups / Users
• CMIS is still a good option
– eg. heterogeneous environments
10. URL Structure
https://host:port/alfresco/api/-default-/public/alfresco/versions/1/…
Scope API Name Version
Entity Relationship (or Operation**)
Tenant
/nodes
/nodes/{id}
/nodes/{id}/children
/nodes/{id}/copy
* Where applicable
** Operations are new for 5.2 (used for specific scenarios where relationship does not make sense)
GET, POST
GET, PUT, DELETE
GET, POST
POST
Deployed Environment
Method (*)
13. • Is your friend !
• Single source of truth
• Open API Spec (~ Swagger)
• Generate client-side bindings
• Developer resource
– http://api-explorer.alfresco.com
– https://github.com/Alfresco/rest-
api-explorer
– http://artificats.alfresco.com
• GAV: org.alfresco.api-explorer (5.2.e/5.2.0)
API Explorer
14. Example: Content Services Core API
Activities
Comments
Favorites
Networks
Nodes
People
Preferences
Queries
Ratings
Renditions
Shared-links
Sites
Tags
Trashcan
Versions
Provides access to the core features of Alfresco Content Services
to retrieve, manage and find entities such as:
16. • Gavin Cornwell
• Series has 8 parts so far
– more coming soon
– includes Postman collections
Community Blog Post Series
https://community.alfresco.com/community/ecm/blog/2016/10/11/v1-rest-api-part-1-introduction
31. Futures
• More Services exposed
– Group Management
– Download as Zip
– …
– Audit ?
– Repository Actions ?
• Other Enhancements
– more REST Framework improvements (eg. batch)
– …
– new features based on your (client-driven) feedback !