Introduction

Welcome to use MeasureSquare cloud APIs.
The Cloud API is organized around REST, has predictable, resource-oriented URLs.

Before use, you need to contact the admin, request an auth name and token key to generate the required authentication string.
For more detail, see Authentication section.

The Cloud API support JSON and XML data format, and uses HTTP response codes to indicate API errors.
For more detail, see Response and Errors section.

New You can access this link to view the new API documentation.

Authentication

You authenticate to the MeasureSquare cloud API by providing your API Key in the request.
You can manage your API Key from your account's API Setting page.
Your API keys carry many privileges, so be sure to keep them secret!

Authentication to the API occurs via HTTP Basic Auth. Provide your API Key as the basic auth username. You do not need to provide a password.
You must authenticate for all requests.
For example:
curl -u PutYourApiKeyHere: --request GET "https://cloud.measuresquare.com/api/projects/count"

X-Headers
X-header parameters are required when calling the API. Contact Measure Square at integration@measuresquare.com to receive both the X-Application and secret key for your application.
The three required parameters are listed below, along with descriptions. Please be aware that they should be provided in your HTTP request header.
X-Application: String associated with your application
X-Timestamp: Current Unix timestamp
X-Signature: Unique signature generated by using both the secret keyand timestamp string to generate a HMAC-SHA256 signature. This must be base 64-encoded.

All API requests must be made over HTTPS. Calls made over HTTP will fail, and the API requests without authentication will also fail.
API Endpoint: https://cloud.measuresquare.com

Response and Errors

The Cloud API support JSON and XML data format.
If set the Request Accept to application/json, the API will return the data with JSON format.
If set the Request Accept to application/xml, the API will return the data with XML format.

The Cloud API uses conventional HTTP status codes to indicate the success or failure of an API request.
In general, it return 200 success status code, and request data.
If the authentication is failed, it will return 401 status code.
If the request data no exists, it will return 400(or 404) status code.
If the request has unkown exception, it will return 500 status code. (These are rare.)
If request failure(non 200 status code), response will also return the defined error message in response content. View Details

Notification

Notification URL is an optional setting.
If you need the project notification, register your URL in API Setting page.
MeasureSquare cloud will notify anytime a project be created or updated, and one parameter called projectId will be attached to your registered URL.

Sample Code

View Details