Exciting New Alfresco REST APIs
- 1. Exciting New Alfresco REST APIs Jan Vonka BeeCon 2017 (Zaragoza)
- 2. REST API Agenda • Introduction • Overview & Architecture • Documentation • What’s New & Changed ? • Demo • What’s Next ? • Summary
- 3. Introduction
- 4. Introduction Jan Vonka • Senior Developer @ Alfresco • Balloonist • http://www.slideshare.net/jvonka
- 5. Disclaimer The information and features presented are subject to change. We look forward to collaborating with you to improve and extend the Alfresco APIs J
- 7. Alfresco Digital Business Platform
- 8. Alfresco API Overview Content Services (Repository) Process Services (Activiti) REST APIREST API Alfresco Platform Micro-Services / Containers Search Services (Solr) Governance Services (RM) RM ECMBPM CMIS (Browser Binding) ADF JavaScript Client Binding HTTPS / JSON /Binary Java Client Binding (EA) Other – Python, Go, … ? RM Apps & Integrations Apps & Integrations Apps & Integrations
- 10. REST API Introduction • The remote public API for all new clients – enabler for Alfresco Digital Business Platform – client-driven features – contract-first design • Open API – consistent, documented, functional, … – performant, secure, reliable …
- 11. REST API Introduction • RESTful Framework – pragmatic, consistent, well-defined guidelines – option for custom / private APIs • eg. https://github.com/covolution/quick-api • CMIS is still a good option – eg. heterogeneous environments (I = interoperability) • WebScripts – custom (”roll-your-own”)
- 12. Context & Use-cases • Digital Business Platform – Applications & integrations – pick & mix services (*) – configure &/or discover … • what’s enabled • incremental new features – Enterprise vs Core • User Roles / Groups – End-User vs Administrators – Managers – Sites, Records – Other Permissions Process (1.6+) Governance (2.6+) Content (5.2+) Search (1.0+)
- 13. 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 (*)
- 14. Documentation
- 15. • 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://artifacts.alfresco.com • GAV: org.alfresco.api-explorer (5.2.e/5.2.0) API Explorer
- 16. Content Services API (v5.2 +) Activities Comments Favorites Networks Nodes (& Associations) People Preferences Queries (Simple) Ratings Renditions Shared-links Search (Advanced) Sites Tags Trashcan Versions
- 17. Process Services API (v1.6 +) Deployments Process Definitions Process Instances Models Executions Task Instances History Forms Signals Management (Tables, Prop’s, Jobs) Identity (Users, Groups) … PS Engine API PS Enterprise API
- 18. Governance Services API (v2.6 +) GS Core API GS Classification Guide API File plans, record categories, record folders, records, etc.
- 19. Community: Blog Post Series • Alfresco v1 REST API by Gavin Cornwell (includes Postman collections) – Part 1 - Introduction – Part 2 - Navigation – Part 3 - Creating Nodes & Uploading Content – Part 4 - Managing Nodes & Download Content – Part 5 - Versioning & Locking – Part 6 - Associations – Part 7 - Collaboration (Comments, Ratings, Tags, ...) – Part 8 - Sites – Part 9 - Queries & Search – Part 10 - People https://community.alfresco.com/community/ecm/blog/2016/10/11/v1-rest-api-part-1-introduction
- 20. https://community.alfresco.com/docs/DOC-6532-alfresco-52-rest-apis Community links - REST APIs • Links to lots of resources – Blogs – Videos – Presentations – Bindings – Sample clients – Docs
- 21. What’s New & Changed ?
- 22. What’s New – Content Services 5.2 • 56 new endpoints – Core API – Authentication API – Discovery API – Search API • REST Framework enhancements – return less => fields query param – return more => include query param (API specific) – operations (eg. /copy, /move, /lock, /unlock, /revert, /restore, …) – @WebApiNoAuth
- 23. Upload content curl -utest:test –X POST http://localhost:8080/alfresco/api/-default-/public/alfresco/versions/1/nodes/-my-/children -F [email protected] Download content curl -utest:test -X GET http://localhost:8080/alfresco/api/-default-/public/alfresco/versions/1/nodes/99a40be1-268f-4b8e-ab49-866747bbd660/content Simple Content Example
- 24. Core API …/alfresco/api/-default-/public/alfresco/versions/1/… • /nodes/{nodeId} – Navigation – Content – Information – Operations include: Copy, Move, Lock, Unlock – Associations • /nodes/{nodeId}/renditions • /nodes/{nodeId}/versions – Operations include: Revert
- 25. Core API …/alfresco/api/-default-/public/alfresco/versions/1/… • /deleted-nodes – Operations: Restore • /queries – /nodes – /people – /sites • /shared-links – public share, unshare, find, … – expiration (new)
- 26. Authentication API …/alfresco/api/-default-/public/authentication/versions/1/… • /tickets – Login – Logout – Validate
- 27. Discovery API …/alfresco/api/… • /discovery – Version information – License information (Enterprise only) – Status • isReadOnly • isQuickSharedEnabled • … – Installed modules
- 28. Search API …/alfresco/api/-default-/public/search/versions/1/... • /search – Low level search API (effectively exposes Java API) – AFTS, CMIS, Lucene support – Faceting – Spellcheck – Term highlighting – Search nodes, versions or deleted-nodes
- 29. Enhanced APIs …/alfresco/api/-default-/public/alfresco/versions/1/… • /sites – Create site (no custom preset support yet) – Update site details – Delete site • /people – List people (no filtering) – Create person – Update person • Enable/Disable (admin only)
- 30. Demo
- 31. Postman Collection • File -> Import -> Import From Link https://www.getpostman.com/collections/3b55c5964cdf44c4836c
- 32. Simple File Sharing prototype (new APIs) Files & Folders Upload & Download Preview Live Search Shared Links Move & Copy Delete & Undo ….
- 33. Client Bindings & Example Apps • JavaScript Client + ADF – ADF 101 tutorial blogs – HealthCare Demo App • Java Client (Early Access) – Java Client blogs – basis for new Android client(s) • Developer Ecosystem - Partners & Community J
- 34. What’s Next ?
- 35. Futures • More Services exposed – Content 5.2.x - Groups, … Audit, Repo Actions, Avatar ? – Governance 2.6.x – Core & Classification Guide – REST Framework improvements (eg. Batch) • Other Enhancements – Event Streams / Change Log – Callbacks - eg. Queues, Web Hooks, Server-Sent Events ?
- 36. Futures • Your feedback – which services to expose next – new features driven by your key use-cases • Contribute ? – pull/merge requests (via git) – API spec – consistent with existing style & guidelines – Implementation code – Test code to validate behaviour (+ve & -ve)
- 37. Summary
- 38. References • Alfresco REST APIs (with more links) https://community.alfresco.com/docs/DOC-6532-alfresco-52-rest-apis • API Explorer https://api-explorer.alfresco.com https://github.com/Alfresco/rest-api-explorer • Intro Video https://www.youtube.com/watch?v=XiU9MMw8LG0