Difference between revisions of "CDN API Documentation"

From Sirikata Wiki
Jump to navigation Jump to search
Line 21: Line 21:
  
 
==Retrieving Single Model Info==
 
==Retrieving Single Model Info==
* /api/modelinfo/
+
* /api/modelinfo/BASENAME/VERSION
 +
 
 +
This retrieves the JSON for a single model with all of its formats.
 +
 
 +
===Example===
 +
http://open3dhub.com/api/modelinfo/jterrace/models/plantbox.dae/0
  
 
==Browsing the CDN==
 
==Browsing the CDN==
* /api/browse
+
* /api/browse/[?start=TIMESTAMP]
 +
 
 +
This browses the models on the CDN. Without a start argument, returns the most recent 25 models on the CDN. It will also contain a "next_start" value, which you can pass later to start at the next timestamp to continue browsing.
 +
 
 +
===Examples===
 +
http://open3dhub.com/api/browse/
 +
http://open3dhub.com/api/browse/?start=1313667443311513
  
 
==Uploading==
 
==Uploading==

Revision as of 21:31, 31 January 2012

Model URLs

The URL for a model consists of:

meerkat://[HOSTNAME]/BASENAME/FORMAT[/VERSION]

Where:

  • BASENAME = The user-chosen path for the model, e.g. /jterrace/duck.dae
  • HOSTNAME = Address of the CDN server. If not specified, the OH client defaults to open3dhub.com
  • FORMAT = One of the CDN formats. Currently supported are "priginal", "pptimized" and "progressive".
  • VERSION = The version number of the model. If not specified, the latest version is returned by the CDN.

Examples

  • Returns the latest version of optimized format:
meerkat:///jterrace/models/plantbox.dae/optimized/plantbox.dae
  • Returns progressive format, version 0:
meerkat:///jterrace/models/plantbox.dae/progressive/0/plantbox.dae
  • Loads from a server on localhost:
meerkat://localhost:8080/jterrace/box.dae

Note

The filename at the end of the URL is technically optional, but the OH won't pick up dependent files, like textures, without it.

Retrieving Single Model Info

  • /api/modelinfo/BASENAME/VERSION

This retrieves the JSON for a single model with all of its formats.

Example

http://open3dhub.com/api/modelinfo/jterrace/models/plantbox.dae/0

Browsing the CDN

  • /api/browse/[?start=TIMESTAMP]

This browses the models on the CDN. Without a start argument, returns the most recent 25 models on the CDN. It will also contain a "next_start" value, which you can pass later to start at the next timestamp to continue browsing.

Examples

http://open3dhub.com/api/browse/ http://open3dhub.com/api/browse/?start=1313667443311513

Uploading

  • /api/upload

Upload Status

  • /upload/processing