Using the CMIS Launch API

In order to provide a seamless user experience, the Fonto CMIS connector provides a launch API which makes it easy to integrate into the user interface of any CMS that supports CMIS.

The integration is as easy as creating a hyperlink with a few parameters. The CMS or DMS may either open the hyperlink in a new browser window or create an iframe.

The URL template for the CMIS Launch API is:

<fontoUrl>/cmis/launch?url={url}&username={userName}&password={password}&objectId={objectId}&path={path}&displayName={displayName}&returnUrl={returnUrl}

Parameter

Description

Required

fontoUrl

URL of the Fonto environment.

If you need access to an integration test environment, please contact us.

Yes

url

The URL of the CMIS root. Please consult the documentation of your repository for details or see this guide.

Yes

userName

The username of the user currently logged in into the CMS.

Yes

password

The password of the user currently logged in into the CMS.

Yes

objectId

The identifier of the CMIS file which to load in Fonto Editor.

Note: The identifier must resolve to a file.

Yes*

path

The path to the CMIS file which to load in Fonto Editor.

The path must begin with a leading slash ‘/’.

The path must resolve to a file.

Yes*

displayName

The display name for the user. This name will be shown at the top right corner of the screen.

No

returnUrl

The CMS return URL. Users will return to this URL when they click 'Save & Close' or 'Log out'. If not supplied, users will be redirected to the Fonto Connectors sign in page.

No

* The objectId and path are mutually exclusive, but one of them must be provided.

When invoked, Fonto Connectors will verify the connection to the identified resource and allow the authenticated user to browse the underlying repository and start editing documents.