Getting Started

Obtain API keys

Complete the Sign up Form to obtain your API keys.

Caplinked will send you an email with your API public and private keys upon account approval. The private (secret) will be used to sign your API requests to the Caplinked API and should be kept privately (i.e. not committed to your source repository). You will be able to reset/roll your private key as needed. The public key will be used to identify your Caplinked API account.

User Tokens
The user token is used to identify the user resource in your organization. All API requests should specificy this header.

Signing your request
You will need to sign your requests with your private key via the HmacSHA256 algorithm. Below is an example done in javascript:

Example

Once you’ve received your CapLinked API key, you can upload and view a file in less than 2 minutes. Follow these commands to get started:

Create your first team
Teams are a way to group users and workspaces.

Create your first workspace
Workspaces are where files are stored, users are granted access, and activity it recorded.

Create a folder
Folders store other folders and files.

Upload a file

Next Steps

There’s so much more you can do with the CapLinked API. Visit the full documentation for an exhaustive list. Here are just a few examples:

Create a group
Groups are where users gain access to folder and files inside a workspace.

Configure permissions for your group
The permissions endpoint are where you decide which files a group can access, and what types of access they have.

Enable watermarking for your group
Custom watermarks are applied to documents in the viewer and upon download. Dynamic watermarks may include crucial user information, such as name, time stamps, email, and IP address.

Create a non-admin user
This user represents the person viewing documents. You will receive a token to make requests on their behalf. Store this user_token so all requests made with it are tied to that user.

Add user to the group
Give permission to a user for viewing folders and files. Use the group id created before in the url.

Note: Use the non-admin user token to request downloads or view files with watermarking enabled.