API REFERENCE GUIDE

to get started  API client

AuverCloud Runtime Client

Goal: Save your time!

The API server can be used with any computer language that supports HTTP communication and JSON. For convenience, AuverCloud proposes JavaScript and PHP runtime libraries in order to quickly start the development of API and content based applications.

Both are open sourced on GitHub as AuverCloud Runtime Client.

AuverCloud JavaScript library - version 3

Requirements

The jQuery library is required (version 2 or more).

Browser support

All the latest and recent versions of standard browsers are supported on both computers, tablets and smartphones.

PLEASE NOTE: MS Internet Explorer ≤ version 9 is not supported.

Introduction

The JavaScript AuverCloud runtime client includes an AJAX function built on top of $.ajax(). It takes care of the following topics:

  • Cross-origin Resource Sharing (CORS)
  • Callbacks for successful and failed calls
  • Progress callback for upload and download
  • Simple call syntax for sessionless and session based API

Basic use

  1. Load jQuery and AuverCloud either standard or minified.
    <script src="http://code.jquery.com/jquery-2.1.4.js"></script>
    <script src="https://www.auvercloud.com/run/js/arc.3.js"></script>

    or

    <script src="http://code.jquery.com/jquery-2.1.4.min.js"></script>
    <script src="https://www.auvercloud.com/run/min/arc.3.min.js"></script>
  2. Make your first call using the method arc.api(parameters, options) and the application key obtained from AuverCloud Studio.
    
    									

Advanced use

Parameters: The API description sections give examples using various parameters and values and their use in the embedded test bed.

Options: The table below summarizes the various options and their default value.

option values / comments
urlAPI server URL. By default, this option is set with the value of the global variable arc.API_URL. This variable and others can be automatically initialized using the method arc.run() (see the AuverCloud runtime client utilities below).
methodHTTP method. Default value: "post".
successCallback function on successful Ajax call. A default console message is displayed if the debug mode is set by arc.run() or the global variable arc.DEBUG.
errorCallback function on failed Ajax call. A default console message is displayed if the debug mode is set with arc.run() or the global variable arc.DEBUG.
sessionDefault value is false. When set to true, it automatically inserts the session parameters and their values which are then not required as declared parameters. See signin and signed for further explanations about authentication and session parameters.
upUpload progress function. A default console message is displayed if the debug mode is set. This callback function has a parameter progress which have a value between 0 and 1.
downDownload progress function. A default console message is displayed if the debug mode is set. This callback function has a parameter progress which have a value between 0 and 1.

AuverCloud runtime client utilities

Please refer to The JavaScript AuverCloud runtime client source code to get further details about the utilities which are provided in this library.

AuverCloud PHP library - version 3

Dedicated to content publising

This library does not contain components which are relevant on an API perspective. More details on GitHub AuverCloud repository.