Skip to content
CCS Files Docs

Choose where to start

Every integration starts with the Identity Server checklist. After that, pick the path that matches what you build. This page is for developers who are about to write their first call.

Your backend talks to the service

Section titled “Your backend talks to the service”

The recommended first integration. Your backend holds a machine client with files:manage and the Node client ccs-files-client. It creates upload tickets for its users, your app sends the bytes straight to the signed URLs, and your backend completes the upload and links the file_id to its own records. Your app never holds a File Service token.

Backend quickstartMedia on a post: ticket, PUT, completion, the feed's URLs.
What to store in your databaseThe file id, a few convenience fields, and never a URL.

Your app calls the service as the user

Section titled “Your app calls the service as the user”

Your backend exchanges the signed-in user’s token for a File Service token and hands it out on a route of its own. Your app then calls the API directly with it, for example to browse folders or search. The token route is the same in every case.

User tokensThe token route in your backend: token exchange for files:access.
PermissionsWhat a user token may do: three levels, six actions.

The user clients do the upload protocol for you, with progress, pause and resume, and show files back: ccs-files-user-client for web apps (with Angular and React adapters) and ccs_files_user_client for Flutter apps. Both also upload a ticket your backend created, with no File Service token in the app.

Web quickstartUploads with progress, pause and resume, previews and video playback in the browser.
Flutter quickstartTicket uploads, the token route, and uploads that resume after the app was killed.

Any other client uses plain HTTP against the API and the upload protocol.

Your backend is not Node.js

Section titled “Your backend is not Node.js”

Every route is described by the OpenAPI document. Generate a client for Java, C#, Python, Go or PHP, and follow the upload protocol for the bytes. See Other languages.

You administer a tenant

Section titled “You administer a tenant”

You need no code. The Files console has pages for browsing, permissions, settings, usage, the audit log, share links and the trash. Start with Administration. If your tenant uses CCS Chat, its attachments are stored here too: see Media in Chat.