Alfresco public REST APIs

[janv]

This document is intended to act as a quick start with links to useful resources. 

Have you had a chance to download the latest Alfresco Content Services release (Enterprise or Community) and try out the public REST APIs ?

Alfresco public APIs cover Content, Search, Process & Governance Services. We have API explorers for each set of services. 

The incremental new public v1 REST APIs introduce features for managing nodes, people, groups, sites, shared-links (... and much more ...) as well built-in queries and new advanced search api for Solr. This is in addition to existing collaborative features, such as favourites, comments, ratings, tags & activities.

We would really appreciate your early feedback. Please comment here or in the forums. If you would like to suggest improvements or see any issues then please feel free to post a separate question or log an issue in JIRA (if repeatable).

Presentations (and slides)

Exciting new Alfresco APIs - YouTube (=> slides ) (BeeCon - Apr 2017)

Developing applications against Alfresco’s unified REST APIs - YouTube (=> slides) (BeeCon - Apr 2017)

Records Management: the API story - YouTube (=> slides) (BeeCon - Apr 2017)

Alfresco 5.2 REST API (London - Mar 2017)

Tech Talk Live #102: REST APIs v1.0 - YouTube (=> slides ) (Feb 2017)

Alfresco Day Vienna 2016: Alfrescos neue Rest API (Vienna - Dec 2016)

REST API Introduction - YouTube (Nov 2016)

REST API of the future - YouTube (=> slides ) (BeeCon - Apr 2016)

Tech Talk Live #93 - The Future of REST APIs - YouTube (=> slides ) (Jan 2016)

API Explorers

• Alfresco Content Services REST API Explorer (includes Search Service)
  • https://api-explorer.alfresco.com/api-explorer/ (Live Sandbox - with "Try it now!" option)
  • https://community.alfresco.com/community/ecm/blog/2017/08/01/live-api-explorer-updated-to-acs-521 
  • https://community.alfresco.com/community/ecm/blog/2017/11/22/live-api-explorer-updated-to-acs-522 

• Alfresco Process Services REST API Explorer 
  • https://activiti.alfresco.com/activiti-app/api-explorer.html 

• Alfresco Governance Services REST API Explorer
  
  • GS Community 2.6 (with download of GS API Explorer) 
  • GS Enterprise 2.6 (with download of GS API Explorer) 

Documentation

• Introduction - REST API & CMIS

  • REST API | Alfresco Documentation

Blog Posts & Tutorials

Gavin Cornwell's excellent series for Alfresco v1 REST API - Content & Search Services

https://community.alfresco.com/community/ecm/blog/2016/10/11/v1-rest-api-part-1-introduction 

https://community.alfresco.com/community/ecm/blog/2016/10/17/v1-rest-api-part-2-navigation 

https://community.alfresco.com/community/ecm/blog/2016/10/24/v1-rest-api-part-3-creating-nodes 

https://community.alfresco.com/community/ecm/blog/2016/11/02/v1-rest-api-part-4-managing-nodes 

https://community.alfresco.com/community/ecm/blog/2016/11/11/v1-rest-api-part-5-versioning-locking 

https://community.alfresco.com/community/ecm/blog/2016/11/23/v1-rest-api-part-6-associations 

https://community.alfresco.com/community/ecm/blog/2016/12/14/v1-rest-api-part-7-collaboration 

https://community.alfresco.com/community/ecm/blog/2017/02/20/v1-rest-api-part-8-sites

https://community.alfresco.com/community/ecm/blog/2017/04/11/v1-rest-api-part-9-queries-search 

https://community.alfresco.com/community/ecm/blog/2017/04/18/v1-rest-api-part-10-people 

https://community.alfresco.com/community/ecm/blog/2017/04/24/v1-rest-api-part-11-trashcan 

https://community.alfresco.com/community/ecm/blog/2017/04/28/v1-rest-api-part-12-discovery 

https://community.alfresco.com/community/ecm/blog/2017/05/02/v1-rest-api-10-things-you-should-know 

More about the Search API

https://community.alfresco.com/people/andy1/blog/2017/05/26/structure-tags-categories-and-query-in-t... 

https://community.alfresco.com/people/andy1/blog/2017/06/28/query-templates-in-share-and-the-public-... 

https://community.alfresco.com/community/ecm/blog/2017/07/17/alfresco-search-services-110 

Governance Services - GS API Explorer & GS Core REST APIs

https://community.alfresco.com/community/ecm/blog/2017/06/27/records-management-community-26a 

https://community.alfresco.com/community/ecm/blog/2017/09/18/records-management-community-26b 

https://community.alfresco.com/community/ecm/blog/2017/11/22/records-management-community-26c 

Client-side SDK & Libraries

JavaScript Client Library (used by ADF - see below)

https://github.com/Alfresco/alfresco-js-api

Developing a simple JavaScript client using the Alfresco REST API (5 part tutorial)

1. Defining the development environment.

2. Authenticating over Alfresco using the Alfresco REST API.

3. Introducing the JavaScript client to list nodes.

4. How to upload new content.

5. How to preview the content.

Example Java Client Library (unsupported)

https://github.com/Alfresco/alfresco-client-sdk

https://github.com/Alfresco/alfresco-client-sdk/tree/DBP  (experimental - for bringing together Content, Process and Governance Services)

https://community.alfresco.com/community/ecm/blog/2016/11/17/alfresco-java-client-sdk (6 part tutorial)

Part 1 Part 2 Part 3Part 4Part 5Part 6 

Example Clients & UI components

Alfresco Digital Workspace

Alfresco Content App (GitHub)

ADF 101 - Getting Started with Alfresco Application Development Framework 

https://community.alfresco.com/community/application-development-framework/blog/2016/06/30/announcin... 

Demo: Alfresco "health-care-app" (dev branch) 

https://community.alfresco.com/community/ecm/blog/2017/02/03/react-components-for-alfresco 

Other related APIs

Quick example of developing a (custom) Rest API on the Alfresco Platform