Hide menu
Introduction

CAD Exchanger Cloud Service API is a set of HTTP URLs to interact with CAD Exchanger Cloud service (cloud.cadexchanger.com). It uses REST architectural style which allow manipulate data on server using GET, POST, PUT, DELETE requests. There are different data collections is used (will be described below).

Typical action with data:

Request type Action
GET Retrieve a representation of the addressed members of the collection
POST Create the member of the collection
PUT Update the addressed member of the collection
DELETE Delete the addressed member of the collection

API uses data in JSON format for requests and for responses. It allows easy to parse/stringify JSON data using JavaScript.

CAD Exchanger collections are named in the plural form (e.g. files, folders, users, etc.). Members of the collection are named in the singular form (e.g. file, folder, user, etc.). So when records from collection are queried API returns object with one array field contains requested records. Field name will be in plural form according to the collection name.

{
"files": [
{ "id": "5a08b2261b0d1303e8e3fbf8", ... },
{ "id": "5a08b2421b0d1303e8e3fbf9", ... }
]
}

When member of collection is queried API returns one field with requested record. Field name will be in singular form according to the collection's member name.

{
"file": {
"id": "5a08b2261b0d1303e8e3fbf8"
...
}
}

When query is failed (e.g. user hasn't permissions to perform the action or request parameters invalid) API returns one errors parameter which represents array of happened errors.

{
"errors": [{
"message": "password-invalid",
"attributes": { "password": "invalid" }
}]
}

Every error object usually contains message and attributes fields. message field contains short description of the error. attributes field represents map of invalid attributes where key is attribute name and value is error code. See "Error" section for every API URL to find more information about possible errors.

Authorization methods return only one error parameter with string error code.