Getting Started

SuiteFiles is a cloud-based document storage and management system used by small-medium businesses for storing their company files and folders.

To use the SuiteFiles developer API, you will first need an application key (App Key) which will be passed to us along with each of your requests. To apply for an App Key, click the Apply to be an App Partner button in the top right corner, complete the details and submit the form. We’ll be in touch to provide you with an App Key once your application has been processed.

Integration Options

We have built our developer API with the intention of making it as easy as possible for you to integrate with SuiteFiles, as well as giving you the ability to build deep integrations as you see fit.

There are three methods for integration which are outlined below and accessible from the sidebar on the left.

Prebuilt Components

We have created prebuilt components to allow for saving and choosing client files within SuiteFiles. These components are intended to be attached to a webpage with the simple import of our provided JavaScript, and with minimal configuration by you as the developer.

Please read further about these components in the Prebuilt Components section.

Client Libraries

We have built client libraries for both C# and JavaScript that will help you to integrate with our API. These libraries aim to minimise any writing of methods to access data to our API for you, and will allow you to just handle the data once it has been retrieved.

In future we will look to increase the number of libraries we support and would love to hear from you if there is a language you think we should be supporting! You can contact us here

Please read further about these components in the Client Libraries section.

RESTful API

If you want to build the entire integration yourself without any of our libraries or components, we welcome you to, and have provided the assisting API documentation.

This documentation is what we have used to write our components, and we will update it with more methods as we develop them.

If you find that there are methods you would like to access that we are not providing, feel free to let us know.

Please read further about our API in the API Reference section.

Authentication

When making requests to the SuiteFiles API, each request will require an App Key specific to your application, as well as an access token, specific to the user's data being interacted with.

For more information regarding acquiring an App Key please read the getting started section

For all requests which are user-relative, you will also require an access token specific to that user. These tokens can be retrieved by following the authentication flow described in the Create an Access Token section.

If an invalid user Access Token, or app key is provided, all requests will recieve a 500 status code in response.

Creating an AccessToken

To get an access token for a user interacting with your app, you will need to use a redirect authentication flow.

This will involve redirecting your users to our authentication page, and then waiting for their access token to be returned in the url parameters.

An example of this may be seen in the provided pre-built components.

The steps required to to do this are documented below:

  1. Direct the user to https://auth.thefullsuite.com/setup.aspx?AppRedirect=YOUR_APP_URL
  2. Once the user has logged in, they will be redirected to the AppRedirect url provided, along with the url parameter suitetoken containing a user relative access token.

Save to SuiteFiles

Using the Suitefiles Picker component, we provide you with the ability to choose files from, or save files to, your client's SuiteFiles sites with minimal code.

This section describes setting up the SuitePicker in order to save content into a folder chosen by your user from their SuiteFiles site.

Importing the SuiteFiles Picker

Please copy & paste into your webpage in order to import the required files to use the SuiteFiles Picker.

<script type="text/javascript" src="https://developer.suitefiles.com/dev/platforms/js/components/suitefiles_chooser.js"></script>

Adding activator button

To add a "Save To SuiteFiles" button, the SuitePicker.createSaverButton function should be used.

SuitePicker.createSaverButton(config, element)

config Object Used to pass parameters to the created Saver window, see below for accepted parameters.
element Element Element to which the created button will be appended.

Config Parameters

appkey String (Required) The appkey parameter identifies your application.
onSuccess callback (Required) The onSuccess function will be called passing back an object containing the url of a temporary container to access the folder chosen by the user which you can then upload content into.

In order to add a "Save To SuiteFiles" button to your web page, please use the following JavaScript snippet as an example.

SuitePicker.createSaverButton(
    {
        appkey: "YOUR APP KEY",
        onSuccess: function(response){
                                    
        }
    }, document.querySelector('body')
);

The code above will append a button element to the provided element (the body tag in the example), which when clicked will open a child window allowing the user to select a folder.

Choose from SuiteFiles

Using the SuiteFiles Picker component, we provide you with the ability to choose files from, or save files to, your client's SuiteFiles sites with minimal code.

This section describes setting up the SuitePicker in order to save content into a folder chosen by your user from thier SuiteFiles site.

Importing the SuiteFiles Picker

Please copy & paste into your webpage in order to import the required files to use the SuiteFiles Picker.

<script type="text/javascript" src="https://developer.suitefiles.com/dev/platforms/js/components/suitefiles_chooser.js"></script>

Adding activator button

To add a "Choose From SuiteFiles" button, the SuitePicker.createChooserButton function should be used.

SuitePicker.createChooserButton(config, element)

config Object Used to pass parameters to the created Chooser window, see below for accepted parameters.
element Element Element to which the created button will be appended.

Config Parameters

appkey String (Required) The appkey parameter identifies your application.
onSuccess callback (Required) The onSuccess function will be called passing back a object containing a url to access the filebytes and information for the files chosen by the user which you can then use.
multiSelect boolean (Required) The multiSelect parameter will determine whether the openend window will support the selection of multiple files.

In order to add a "Choose To SuiteFiles" button to your web page, please use the following JavaScript snippet as an example.

SuitePicker.createChooserButton(
    {
        appkey: "YOUR APP KEY",
        onSuccess: function (response) {
                                    
        },
        multiSelect: true
}, document.querySelector('body'));

The code above will append a button element to the provided element (the body tag in the example), which when clicked will open a child window allowing the user to select a number of files.

Open SuiteFiles Connect

Blue Button

Demo

Setup

Embed code

To create the styled button above, you can use the following code snippet:

<style>
    a.suitefiles-connect-btn {
        background-color: #4673F3;
        display: block;
        float: left;
        -webkit-box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
        -moz-box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
        box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
        color: #ffffff;
        padding: 8px 20px;
        border-radius: 20px;
        font-size: 16px;
        font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
        text-decoration: none;
        transition: background-color 0.5s ease;
    }
    a.suitefiles-connect-btn:hover {
        background-color: #164ff0;
    }

    a.suitefiles-connect-btn span {
        margin-left: 8px; 
        float: left;
    }

    a.suitefiles-connect-btn svg {
        padding-top: 3px; 
        float: left;
    }
</style>
<a href="https://connect.suitefiles.com/login.aspx" target="_blank" class="suitefiles-connect-btn">
    <svg id="Group_6878" data-name="SuiteFiles Cloud Icon" xmlns="http://www.w3.org/2000/svg" width="24.954"
        height="16.21" viewBox="0 0 24.954 16.21">
        <path id="Path_8949" data-name="Path 8949"
            d="M212.677,7.752a7.061,7.061,0,0,0,.081-1.134c0-.152-.011-.3-.022-.45-.006-.043-.006-.087-.011-.13-.005-.065-.022-.13-.027-.2,0-.011-.005-.016-.005-.027a6.037,6.037,0,0,0-.212-.987A6.728,6.728,0,0,0,206.162,0,6.181,6.181,0,0,0,201.1,2.544,5.461,5.461,0,0,1,202.462,3.7a3.147,3.147,0,0,1,.526,1.8V16.188l2.289-2.268h6.694a3.188,3.188,0,0,0,3.174-3.174A3.117,3.117,0,0,0,212.677,7.752Z"
            transform="translate(-190.191)" fill="#ffffff" />
        <path id="Path_8950" data-name="Path 8950"
            d="M7.513,39a5.237,5.237,0,0,0-5.2,5.11c0,.157.076.374.087.526A2.859,2.859,0,0,0,.532,45.911a3.225,3.225,0,0,0-.385.8c-.027.087-.049.179-.071.271A3.044,3.044,0,0,0,0,47.658,3.113,3.113,0,0,0,3.108,50.8H9.8l2.289,2.289V42.174C12.092,40.638,9.586,39,7.513,39Z"
            transform="translate(0 -36.884)" fill="#ffffff" />
    </svg>
    <span>Open SuiteFiles Connect</span>
</a>
                    

White Button

Demo

Setup

Embed code

To create the styled button above, you can use the following code snippet:

<style>
        a.suitefiles-connect-btn {
            background-color: #ffffff;
            display: block;
            float: left;
            -webkit-box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
            -moz-box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
            box-shadow: 0px 1px 3px 0px rgba(0, 0, 0, 0.33);
            color: #434F66;
            padding: 8px 20px;
            border-radius: 20px;
            font-size: 16px;
            font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
            text-decoration: none;
            transition: background-color 0.5s ease;
        }

        a.suitefiles-connect-btn:hover {
            background-color: #F8F8F8;
        }

        a.suitefiles-connect-btn span {
            margin-left: 8px; 
            float: left;
        }

        a.suitefiles-connect-btn svg {
            padding-top: 3px; 
            float: left;
        }
    </style>
    <a href="https://connect.suitefiles.com/login.aspx" target="_blank" class="suitefiles-connect-btn">
        <svg id="Group_6878" data-name="SuiteFiles Cloud Icon" xmlns="http://www.w3.org/2000/svg" width="24.954"
            height="16.21" viewBox="0 0 24.954 16.21">
            <path id="Path_8949" data-name="Path 8949"
                d="M212.677,7.752a7.061,7.061,0,0,0,.081-1.134c0-.152-.011-.3-.022-.45-.006-.043-.006-.087-.011-.13-.005-.065-.022-.13-.027-.2,0-.011-.005-.016-.005-.027a6.037,6.037,0,0,0-.212-.987A6.728,6.728,0,0,0,206.162,0,6.181,6.181,0,0,0,201.1,2.544,5.461,5.461,0,0,1,202.462,3.7a3.147,3.147,0,0,1,.526,1.8V16.188l2.289-2.268h6.694a3.188,3.188,0,0,0,3.174-3.174A3.117,3.117,0,0,0,212.677,7.752Z"
                transform="translate(-190.191)" fill="#46c8f5" />
            <path id="Path_8950" data-name="Path 8950"
                d="M7.513,39a5.237,5.237,0,0,0-5.2,5.11c0,.157.076.374.087.526A2.859,2.859,0,0,0,.532,45.911a3.225,3.225,0,0,0-.385.8c-.027.087-.049.179-.071.271A3.044,3.044,0,0,0,0,47.658,3.113,3.113,0,0,0,3.108,50.8H9.8l2.289,2.289V42.174C12.092,40.638,9.586,39,7.513,39Z"
                transform="translate(0 -36.884)" fill="#4673f3" />
        </svg>
        <span>Open SuiteFiles Connect</span>
    </a>
                    

Link To SuiteFiles

Using the SuiteFiles Link component, we provide you with the ability to open a web browser to the web url of a folderpath.

This section describes how you can use the SuiteFiles Link component in your website.

Importing the SuiteFiles Link Component

Please copy & paste into your webpage in order to import the required files to use the SuiteFiles Link.

<script type="text/javascript" src="https://developer.suitefiles.com/dev/platforms/js/components/suitefiles_link.js"></script>

Opening a Folder

The JavaScript package contains a method to open a given folder path in SuiteFiles, handling any authentication that is required.

SuiteLink.openSuiteFilesWithPath(path, appKey)

path String (Required) The folder path to be opened in the browser.
appkey String (Required) The appkey parameter identifies your application.

Client Libraries

To try and help you speed up the process of integration and avoid having to build everything yourself, we have provided some client libraries to integrate with our API.

The C# client library aims to help with server integrations by providing the same API methods, however also providing methods to help generate access tokens for server integrations.

The JavaScript client library aims to wrap all of the partner API methods available and help you to build front-end integrations.

C# Client Library

To use the C# client libarary to help build server-side integrations, please get the package from NuGet.

The client library provides pre-built methods for integrating with our API, and to produce access tokens for your users.

You can search for this NuGet package within Visual Studio, or access the NuGet package directly from here

https://www.nuget.org/packages/SuiteFiles.API

Within the package you will be able to use ready-implemented methods to use the API.

JavaScript Client Library

To use the Javascript library please import the following script

<script type="text/javascript" src="https://developer.suitefiles.com/dev/platforms/js/components/SuiteAPI-1.0.0.js"></script>

Parameters

Body

Description

Full Request Url


                        
                            
                        

Example JSON Response