Developer Reference

Web API

Introduction

This document defines the end points, request and response definitions of CloudyRec backend web service Version 0.1 application interface. The required information such as app key, resource keys can be found under Sandbox or Production sections of your developer dashboard. Record IDs can be find through the data browser.


Security

Back to top


Sandbox vs Production

Sandbox API

Sandbox Endpoint

Production Instance API

Production Endpoint

Back to top


Data Exchange Format


Error Response


{message" : "custom error message}

Back to top


Create New Resource


http://[end_point]/:version/:app_key/:resource_key

Response

Back to top


Authenticate a Resource


http://[end_point]/:version/:app_key/:resource_key/auth

Response

Back to top


Edit Existing Resource


http://[end_point]/:version/:app_key/:resource_key/:resource_id

Response

Back to top


Delete Existing Resource


http://[end_point]/:version/:app_key/:resource_key/:resource_id

Response

Back to top


List Existing Resources


http://[end_point]/:version/:app_key/:resource_key/

Pagination Parameters

Please note that p number starts at 1.

*Example:


http://[end_point]/:version/:app_key/:resource_key?l=1&p=1

Let’s say we have 2 resources called ‘user’ and ‘post’. And ‘post’ belongs to ‘user’. So if you want to retrieve all the posts belong to a particular user, the resource key will be the key for ‘post’ and ‘master_id’ will the id of that particular user.

Create New Related Resource


http://[end_point]/:version/:app_key/:resource_key

Back to top


Uploading new file to Fstore

Response

Back to top


Listing Fstore records

Response

Pagination Parameters

Back to top


Downloading file from Fstore

Response

Back to top


Deleting file from Fstore

Response

Back to top


Setting tags for Fstore file

Response

Back to top


Getting tags for Fstore file

Response

Back to top


Common Error Responses

Date Types

CloudyRec allows following data types for attributes;

Special note for Encrypted String

Special note for Unique String

Back to top


URL Listing



#EPMethodURLDescription
EP01 N.A N.A Reserved
EP02 GET /:version/:app_key/count Get total record count for for all resources of given app.
EP03 GET /:version/:app_key/:resource_key/count Get total record count for given app and resource keys.
EP04 GET /:version/:app_key/:resource_key Get resource list for given app and resource keys.
EP05 GET /:version/:app_key/:resource_key/cof/:master_id Get related resource list,from given app key, of the type of given resource keys, which has given master_id.
EP06 GET /:version/:app_key/:resource_key/:resource_id Get details attributes and values, from given app key, of the type of given resource keys, of given resource id.
EP07 POST /:version/:app_key/:resource_key Create a new resource of given app and resource keys.
EP08 POST /:version/:app_key/:resource_key/auth Authenticate a resource of given app and resource keys.
EP09 PUT /:version/:app_key/:resource_key/:resource_id Update a resource with given attribute.
EP10 DELETE /:version/:app_key/:resource_key/:resource_id Delete a resource with given resource_id.

Back to top