Getting Started

SuiteFiles is a secure and scalable cloud-based digital workspace solution.

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.

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.

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.blue {
        background-color: #4F7EFF;
        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);
        padding: 8px 10px;
        border-radius: 5px;
        font-size: 16px;
        font-family: Ubuntu, Tahoma, Geneva, Verdana, sans-serif;
        font-weight: 300;
        text-decoration: none;
        transition: background-color 0.5s ease;
        cursor: pointer;

    }

    a.suitefiles-connect-btn.blue:hover {
        background-color: #164ff0;
    }

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

    a.suitefiles-connect-btn svg {
        float: left;
        height: 22px;
    }
</style>

<a href="https://connect.suitefiles.com/login.aspx" target="_blank" class="suitefiles-connect-btn blue">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 66.734 120.905">
        <g id="SF_icon_-_White" data-name="SF icon - White" transform="translate(-3702.74 -7235.75)">
            <path id="Path_9298" data-name="Path 9298" d="M60.215,65.115V15.75L15.74,87.289H38V65.115Z" transform="translate(3687 7220)" fill="#fff" />
            <path id="Path_9299" data-name="Path 9299" d="M65.495,27.46H43.236V49.634H21.02V99Z" transform="translate(3703.979 7257.655)" fill="#fff" />
        </<g>
    </<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.white {
        background-color: #ffffff;
        color: #434F66;
        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);
        padding: 8px 10px;
        border-radius: 5px;
        font-size: 16px;
        font-family: Ubuntu, Tahoma, Geneva, Verdana, sans-serif;
        font-weight: 300;
        text-decoration: none;
        transition: background-color 0.5s ease;
        cursor: pointer;

    }

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

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

    a.suitefiles-connect-btn svg {
        float: left;
        height: 22px;
    }
</style>

<a href="https://connect.suitefiles.com/login.aspx" target="_blank" class="suitefiles-connect-btn white">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 66.734 120.905">
        <g id="SF_Icon_-_Colour" data-name="SF Icon - Colour" transform="translate(-3702.74 -7235.75)">
        <path id="Path_9298" data-name="Path 9298" d="M60.215,65.115V15.75L15.74,87.289H38V65.115Z" transform="translate(3687 7220)" fill="#4f7eff"/>
        <path id="Path_9299" data-name="Path 9299" d="M65.495,27.46H43.236V49.634H21.02V99Z" transform="translate(3703.979 7257.655)" fill="#ee3967"/>
        <rect id="Rectangle_24646" data-name="Rectangle 24646" width="22.174" height="22.132" transform="translate(3725.041 7285.115)" fill="#ffcb05"/>
        </g>
    </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)