XMediusSENDSECURE (SendSecure) is a collaborative file exchange platform that is both highly secure and simple to use. It is expressly designed to allow for the secured exchange of sensitive documents via virtual SafeBoxes.

SendSecure comes with a Web API, which is RESTful, uses HTTPs and returns JSON.

Specific libraries have been published for various languages: C#, Java, JavaScript, PHP, Python and Ruby.

sendsecure-csharp

This library allows you to use the SendSecure Web API via C# with .NET.

With this library, you will be able to:

• Authenticate SendSecure users
• Create new SafeBoxes

Table of Contents

• Installation
• Quick Start
• Usage
• License
• Credits

Installation

Prerequisites

• .NET version 4.5.2+
• The SendSecure service, provided by XMedius (demo accounts available on demand)

Install Package

To use sendsecure-csharp in your C# project, clone or download the SendSecure C# .NET libraries directly from our GitHub repository.

Quick Start

Authentication (Retrieving API Token)

Authentication is done using an API Token, which must be first obtained based on SendSecure enterprise account and user credentials. Here is the minimum code to get such a user-based API Token.

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using XMedius.SendSecure;

namespace SendSecureClient
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string token = GetUserToken().Result;
            }
            catch (XMedius.SendSecure.Exceptions.SendSecureException e)
            {
                Console.WriteLine(e.Message);
                if(!String.IsNullOrEmpty(e.Response))
                {
                    Console.WriteLine("Server response: " + e.Response);
                }
            }
        }

        public static async Task<string> GetUserToken()
        {
            string token = await XMedius.SendSecure.Client.GetUserToken("deathstar", "darthvader", "d@Rk$1De", "DV-TIE/x1", "TIE Advanced x1", "The Force App", new Uri("https://portal.xmedius.com"));

            Console.WriteLine(token);
            return token;
        }
    }
}

SafeBox Creation (Using SafeBox Helper Class)

Here is the minimum required code to create a SafeBox – with 1 recipient, a subject, a message and 1 attachment. This example uses the user's default security profile (which requires to be set in the account).

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using XMedius.SendSecure;

namespace SendSecureClient
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                string token = "USER|1d495165-4953-4457-8b5b-4fcf801e621a";

                string previewUrl = SubmitSafebox(token).GetAwaiter().GetResult();
            }
            catch (XMedius.SendSecure.Exceptions.SendSecureException e)
            {
                Console.WriteLine(e.Message);
                if(!String.IsNullOrEmpty(e.Response))
                {
                    Console.WriteLine("Server response: " + e.Response);
                }
            }
        }

        public static async Task<string> SubmitSafebox(string token)
        {
            var safebox2 = new XMedius.SendSecure.Helpers.Safebox("[email protected]");
            safebox2.Subject = "Family matters";
            safebox2.Message = "Son, you will find attached the evidence.";

            safebox2.Attachments.Add(new XMedius.SendSecure.Helpers.Attachment("d:\\Birth_Certificate.pdf"));

            var recipient = new XMedius.SendSecure.Helpers.Recipient("[email protected]");
            var contactMethod = new XMedius.SendSecure.Helpers.ContactMethod { Destination = "555-232-5334", DestinationType = XMedius.SendSecure.Helpers.ContactMethod.DestinationTypeT.CellPhone };
            recipient.ContactMethods.Add(contactMethod);
            safebox2.Recipients.Add(recipient);

            XMedius.SendSecure.Client client = new Client(token, "deathstar", new Uri("https://portal.xmedius.com"));
            XMedius.SendSecure.Helpers.SafeboxResponse safeboxResponse = await client.SubmitSafebox(safebox2);

            Console.WriteLine(safeboxResponse.PreviewUrl);
            return safeboxResponse.PreviewUrl;
        }
    }
}

Usage

Helper Methods

Get User Token

GetUserToken(enterpriseAccount, username, password, deviceId, deviceName, applicationType, endpoint, oneTimePassword, cancellationToken)

Creates and returns an API Token for a specific user within a SendSecure enterprise account. Calling this method again with the exact same params will always return the same Token.

Param	Type	Definition
enterpriseAccount	String	The SendSecure enterprise account
username	String	The username of a SendSecure user of the current enterprise account
password	String	The password of this user
deviceId	String	The unique ID of the device used to get the Token
deviceName	String	The name of the device used to get the Token
applicationType	String	The type/name of the application used to get the Token ("SendSecure C#" will be used by default if empty)
endpoint	Uri	The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
oneTimePassword	String	The one-time password of this user (if any)
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Client Object Constructor

Client(apiToken, enterpriseAccount, endpoint, locale)

Param	Type	Definition
apiToken	String	The API Token to be used for authentication with the SendSecure service
enterpriseAccount	String	The SendSecure enterprise account
endpoint	Uri	The URL to the SendSecure service ("https://portal.xmedius.com" will be used by default if empty)
locale	String	The locale in which the server errors will be returned ("en" will be used by default if empty)

Get Enterprise Settings

EnterpriseSettings(cancellationToken)

Returns all values/properties of the enterprise account's settings specific to SendSecure.

Param	Type	Definition
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Get Default Security Profile

DefaultSecurityProfile(userEmail, cancellationToken)

Returns the default security profile (if it has been set) for a specific user, with all its setting values/properties.

Param	Type	Definition
userEmail	String	The email address of a SendSecure user of the current enterprise account
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Get Security Profiles

SecurityProfiles(userEmail, cancellationToken)

Returns the list of all security profiles available to a specific user, with all their setting values/properties.

Param	Type	Definition
userEmail	String	The email address of a SendSecure user of the current enterprise account
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Initialize SafeBox

InitializeSafebox(safebox, cancellationToken)

Pre-creates a SafeBox on the SendSecure system and returns the updated Safebox object with the necessary system parameters filled out (GUID, public encryption key, upload URL).

Param	Type	Definition
safebox	String	A Safebox object to be initialized by the SendSecure system
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Upload Attachment

UploadAttachment(safebox, attachment, cancellationToken)

Uploads the specified file as an Attachment of the specified SafeBox and returns the updated Attachment object with the GUID parameter filled out.

Param	Type	Definition
safebox	Safebox	An initialized Safebox object
attachment	Attachment	An Attachment object - the file to upload to the SendSecure system
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Commit SafeBox

CommitSafebox(safebox, cancellationToken)

Finalizes the creation (commit) of the SafeBox on the SendSecure system. This actually "Sends" the SafeBox with all content and contact info previously specified.

Param	Type	Definition
safebox	Safebox	A Safebox object already initialized, with security profile, recipient(s), subject and message already defined, and attachments already uploaded.
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Submit SafeBox

SubmitSafebox(safebox, cancellationToken)

This method is a high-level combo that initializes the SafeBox, uploads all attachments and commits the SafeBox.

Param	Type	Definition
safebox	Safebox	A non-initialized Safebox object with security profile, recipient(s), subject, message and attachments (not yet uploaded) already defined.
cancellationToken	CancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation

Helper Modules

Safebox

SafeboxResponse

Attachment

Recipient

ContactMethod

SecurityProfile

EnterpriseSettings

ExtensionFilter

License

sendsecure-csharp is distributed under MIT License.

Credits

sendsecure-csharp is developed, maintained and supported by XMedius Solutions Inc. The names and logos for sendsecure-csharp are trademarks of XMedius Solutions Inc.