Public Alfresco API is Now Live

[jpotts]

This morning, Alfresco announced the general availability of the public Alfresco API. The public Alfresco API allows developers to create custom applications (desktop, mobile, or cloud) that persist content to Alfresco in the Cloud. The API includes CMIS plus some Alfresco REST calls that provide functionality CMIS does not cover.

To use the Alfresco API, all you have to do is become a registered developer at http://developer.alfresco.com. Once you've verified your email address, you can add applications to your profile. Each application has a unique authentication key and a secret. OAuth2 is used to handle authentication.

Once you have your authentication key and secret, you can start making calls against the API. Calls that hit the Alfresco REST part of the API return JSON. Calls that leverage CMIS return AtomPub XML. If you already know how to make CMIS calls, you already know how to use the Alfresco API–just grab the latest version of your favorite CMIS client, like OpenCMIS or cmislib, and pass in the authorization header.

Here are some resources to help you get started:
<a href="https://developer.alfresco.com">Alfresco Developer Portal</a>
<a href="https://developer.alfresco.com/resources/alfresco/pdf/AlfrescoAPIReference-v1.0.pdf">Alfresco API Documentation</a>
<a href="http://www.slideshare.net/jpotts/announcing-the-public-alfresco-api">Introduction Presentation</a> from JavaOne
<a href="https://www.youtube.com/playlist?list=PLOEM5PcngNJV3weFgkCI6_yYdaYEPjQqc">Alfresco API Screencasts</a> showing how to register for an application key and how to execute simple command-line Java applications that leverage the API
<a href="https://code.google.com/p/alfresco-api-java-examples/">Sample Java code</a> showing simple command-line examples with Google's OAuth2 client and the Alfresco API.
<a href="https://code.google.com/p/alfresco-api-python-examples/">Python examples</a> showing the same command-line examples as the Java examples above.

If you want to discuss the public Alfresco API, use <a href="https://forums.alfresco.com/forum/developer-discussions/alfresco-api">this forum</a>.

Jeff

[jpotts]

In addition to the sample Java command-line project referenced, there is also:

Peter Monks' sample grails app

Gethin James' sample Java webapp

Jeff

[pmonks]

It warms my heart to see the correct use of apostrophes in pronouns!

[jpotts]

And <a href="https://devcon.alfresco.com/sanjose/sessions/alfresco-cloud-api-part-one">here</a> is a link to the DevCon 2012 session, which includes a video of the API workshop along with a link to the slides.

Jeff

[mbeteta]

Hello,

For the OAuth2 protocol, it seems that it's not possible to set a callback URL with special characters like this  : "https://mydomain.com/myapp/#!/myalfrescopage". (get a "Mismatching redirect uri")

I use Vaadin7 (GWT Wrapper Java) for the front-end development wich uses that kind of URL.

Do you confirm that point ? Will you accept that kind of URL in the future ? (Box.Net for instance accept)

Thanks a lot !

MBeteta

Ps : I made a test with an URL like this "https://mydomain.com/myapp" and the callback works but I can not integrate with Vaadin7