API REFERENCE GUIDE

cloud content  content_pub

api description

purpose

content_pub aims at publishing HTML content edited in AuverCloud Studio. Three types of content are supported:

  • Rich text
  • Picture or slideshow
  • Menu

PLEASE NOTE: content_pub requires the following CSS template https://www.auvercloud.com/run/css/arc.3.css to publish the HTML contents. Do not hesitate to overwrite it or to design your own customized version.

PLEASE NOTE: For slideshow content (i.e. several pictures with transition effects), additional JavaScript is required to play the animations. More details in the API client section.

http method: GET

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"content_pub"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
cnameContent name as defined in AuverCloud Studio e.g. "hello_world"
ctypeContent type is one of the following values: "text", "picture", "menu".

optional parameters(s)

parameter values / comments
outputThis parameter defines the response output format. The value should be either json or html (default value) which can more convient for calls from PHP clients.
cdateE.g. "2014-02-14 14:50:30". Content date to request an archived version of a text content. By default the current version is returned.
udateSame parameter but URL encoded. If both valid parameters are provided, cdate wins.

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


								

As this API method is GET, the following URL returns a similar HTML response:

errors

code message comments
640 Unknown content. This occurs when the combination of content name, type and date does not exist in the account related to the application key.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
content_pub
key
cname
ctype
cdate
output
json
 send
request
 clear
response
Response
code
msg
data

discussion