Nomadesk API

Getting started

Overview

This document is intended for third parties that want to integrate their application environment with the Nomadesk platform using the Nomadesk API.

Using the Nomadesk API gives you the opportunity to get all functionality that is available on the myNomadesk website to end users.

All API calls are presented with an example usage using cURL.

The API is a work in progress and subject to adaptations and modifications.
All modifications will be available on the API Changelog page.

Example using the Logon() API call using an end user's credentials

curl -v 'https://secure.nomadesk.com/ctrller/api.php?Task=Logon&Email=api@nomadesk.com&Password=password'

Every response is encapsulated in the Response XML tags and has a Status and Message tag
accompanying the results based on the API call.

RESPONSE

<Response>
    <Status>1</Status>
    <Message></Message>
    <Token>realorgc0vl7jtipak1qra1nc3</Token>
    <AccountInfo>
        <FirstName>api</FirstName>
        <LastName>003</LastName>
        <Email>api@nomadesk.com</Email>
        <Language>en-us</Language>
        <BrandingID>NMD</BrandingID>
        <IsTrial>true</IsTrial>
    </AccountInfo>
</Response>

Authentication

AMS

Some API calls are limited to users with the proper permissions to perform the task.
For these you'll need to pass a security Token with the API call of the authenticated AMS user.

User

Any user with an account in Nomadesk is able to use the API and perform the basic functionalities as found on myNomadesk.

Server

The API calls are executed from a server who's IP address has been authorized and therefore trusted.

More details about the different logon methods are found here: API Logon

Which API methods are available?

The Nomadesk API is devided in 2 components, Controller and Storage.

What's the difference between CONTROLLER & STORAGE ?

The Controller API is used to handle everything that is not related to the storage.
All functionalities that you see in myNomadesk are handled by the Controller API ( ex: FileLink, FolderLink, Accountinfo, ... )

The Storage API method handles all data related functionalities.

To perform the API calls you need to specify the method in the URL.

Controller : https://secure.nomadesk.com/ctrller/api.php

Storage    : https://storage001.nomadesk.com/storage/api.php

Terminology

AMSToken : security token, acquired when logging in with an AMS user.
Token : security token, acquired when an end-user logs in
Fileserver / Vault : Both terms refer to the virtual hard drive where a user's data is stored.

Getting Started