Caplinked - the C# library for the CapLinked API v1.0

Overview

C# (C sharp /.NET) SDK for the Caplinked API.

Core information security endpoints for managing your virtual data room capabilities around files/folders, users/groups and permissions, uploads/downloads, dynamic watermarking, DRM (digital rights management) and more.

Vist Caplinked for more information.

Frameworks supported

• .NET 4.0 or later
• Windows Phone 7.1 (Mango)

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later

The DLLs included in the package may not be the latest version. We recommend using [NuGet] (https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

Installation

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using Caplinked.Api;
using Caplinked.Client;
using Caplinked.Model;

Getting Started

using System;
using System.Diagnostics;
using Caplinked.Api;
using Caplinked.Client;
using Caplinked.Model;

namespace Example
{
    public class Example
    {
        public void main()
        {
            var apiInstance = new UsersApi();
            apiInstance.Configuration.SetApiPublicKey("0c1da72601ca7c39df77a317d93c1caefccdd216");
            apiInstance.Configuration.SetApiSecretKey("cad02b1a2593862c5f151a5b8496f6e60c8581c82697ad706d8930bbd5684ba3");
            apiInstance.Configuration.SetApiUserToken("1b62543ca4f8311e9bd0e628705d76fb6aca1bd9");

	    try
	    {
	        // Get info of user resource token
                Console.WriteLine("Fetching user info");
		User result = apiInstance.GetUsersMe();
		Console.WriteLine(result.FirstName);
	    }
	    catch (Exception e)
	    {
		Console.WriteLine("Exception when calling UsersApi.GetUsersMe: " + e.Message);
	    }
	}
    }
}

Documentation for API Endpoints

All URIs are relative to https://sandbox.caplinked.com/api/v1

Class	Method	HTTP request	Description
ActivitiesApi	GetActivitiesWorkspaceWorkspaceId	GET /activities/workspace/{workspace_id}	Get workspace activities
DownloadsApi	DeleteDownloadsId	DELETE /downloads/{id}	Delete download
DownloadsApi	GetDownloadsFileFileId	GET /downloads/file/{file_id}	Get single file
DownloadsApi	GetDownloadsId	GET /downloads/{id}	Get zip
DownloadsApi	GetDownloadsStatusWorkspaceId	GET /downloads/status/{workspace_id}	Get status of downloads for current user
DownloadsApi	PostDownloads	POST /downloads	Create zip file
FilesApi	DeleteFilesId	DELETE /files/{id}	Delete file
FilesApi	GetFilesId	GET /files/{id}	Get file information
FilesApi	PostFilesIdCopy	POST /files/{id}/copy	Copy file
FilesApi	PostFilesIdMove	POST /files/{id}/move	Move file
FilesApi	PutFilesId	PUT /files/{id}	Update file information
FilesApi	PutFilesUpload	PUT /files/upload	Upload file
FoldersApi	DeleteFoldersId	DELETE /folders/{id}	Delete folder
FoldersApi	GetFoldersId	GET /folders/{id}	Get folder information
FoldersApi	PostFolders	POST /folders	Create new folder
FoldersApi	PostFoldersIdCopy	POST /folders/{id}/copy	Copy folder
FoldersApi	PostFoldersIdMove	POST /folders/{id}/move	Move folder
FoldersApi	PutFoldersId	PUT /folders/{id}	Update folder information
GroupsApi	DeleteGroupsId	DELETE /groups/{id}	Delete group
GroupsApi	DeleteGroupsIdMemberships	DELETE /groups/{id}/memberships	Remove a user from a group
GroupsApi	GetGroups	GET /groups	List all groups in workspace
GroupsApi	GetGroupsId	GET /groups/{id}	Get group information
GroupsApi	GetGroupsIdMemberships	GET /groups/{id}/memberships	List all memberships for a group
GroupsApi	PostGroups	POST /groups	Create group
GroupsApi	PostGroupsIdMemberships	POST /groups/{id}/memberships	Add user to group (adds to parent workspace if they are not already a member)
GroupsApi	PutGroupsId	PUT /groups/{id}	Update group
GroupsApi	PutGroupsIdDisableDrmExpiration	PUT /groups/{id}/disable_drm_expiration	Disable DRM expiration for group
GroupsApi	PutGroupsIdDisableExpireAccess	PUT /groups/{id}/disable_expire_access	Disable access expiration for a group
GroupsApi	PutGroupsIdDrm	PUT /groups/{id}/drm	Update DRM for group
GroupsApi	PutGroupsIdEnableExpireAccess	PUT /groups/{id}/enable_expire_access	Enable access expiration for a group
GroupsApi	PutGroupsIdWatermarking	PUT /groups/{id}/watermarking	Watermarking for group
OrganizationApi	DeleteOrganizationMemberships	DELETE /organization/memberships	Remove organization admin membership
OrganizationApi	GetOrganization	GET /organization	Get organization information
OrganizationApi	GetOrganizationMemberships	GET /organization/memberships	Show all organization members
OrganizationApi	PostOrganizationMemberships	POST /organization/memberships	Add organization admin membership
OrganizationApi	PutOrganization	PUT /organization	Update organization information
OrganizationApi	PutOrganizationSupportInformation	PUT /organization/support_information	Update support information of organization
PermissionsApi	GetPermissionsFoldersId	GET /permissions/folders/{id}	List subfolder permissions
PermissionsApi	PutPermissionsFoldersId	PUT /permissions/folders/{id}	Update folder permissions
TeamsApi	DeleteTeamsIdMemberships	DELETE /teams/{id}/memberships	Remove team member
TeamsApi	GetTeams	GET /teams	List all teams in organization
TeamsApi	GetTeamsId	GET /teams/{id}	Get team information
TeamsApi	GetTeamsIdMemberships	GET /teams/{id}/memberships	Get list of team members
TeamsApi	GetTeamsIdWatermarkSettings	GET /teams/{id}/watermark_settings	List custom watermarks for a team
TeamsApi	PostTeams	POST /teams	Create team
TeamsApi	PostTeamsIdMemberships	POST /teams/{id}/memberships	Add team member
TeamsApi	PutTeamsId	PUT /teams/{id}	Update team
UsersApi	DeleteUsers	DELETE /users	Delete user
UsersApi	GetUsersMe	GET /users/me	Get user information
UsersApi	PostUsers	POST /users	Create user
UsersApi	PutUsersMe	PUT /users/me	Update a user
WatermarkApi	DeleteWatermarkId	DELETE /watermark/{id}	Delete custom watermark
WatermarkApi	GetWatermarkId	GET /watermark/{id}	Get custom watermark setting
WatermarkApi	PostWatermark	POST /watermark	Add custom watermark
WatermarkApi	PutWatermarkId	PUT /watermark/{id}	Update custom watermark
WorkspacesApi	GetWorkspaces	GET /workspaces	List all workspaces for a team
WorkspacesApi	GetWorkspacesId	GET /workspaces/{id}	Get workspace information
WorkspacesApi	PostWorkspaces	POST /workspaces	Create workspace
WorkspacesApi	PutWorkspacesId	PUT /workspaces/{id}	Update workspace

Documentation for Models

• Model.Activity
• Model.CustomWatermarkSetting
• Model.Delete
• Model.ExpiringUrl
• Model.FileCopyMove
• Model.FileDelete
• Model.FileInfoCompact
• Model.FileInfoMapped
• Model.FileViewerImage
• Model.FolderContent
• Model.FolderCopyMove
• Model.FolderDelete
• Model.FolderList
• Model.FolderMeta
• Model.FolderUpdate
• Model.GroupInfo
• Model.GroupInfoDeleted
• Model.Membership
• Model.Meta
• Model.Organization
• Model.OrganizationMembership
• Model.StatusMessage
• Model.SupportInformation
• Model.Team
• Model.User
• Model.Workspace

Documentation for Authorization

See example on Getting Started