Designs¶
This API allows requesting information on a set of designs. The list of designs matching a given query is obtained by accessing this URL with the GET method:
https://www.sculpteo.com/LANGUAGE_CODE/gallery/x_design_list/
replacing LANGUAGE_CODE with either ‘en’ or ‘fr’ for localization.
Several paramaters may be appended to the URL to describe the query:
- order_by
‘timestamp’ or ‘rate’; changes the ordering of the response
- designer
show only the designs of this user
- design_list
show only designs in the design list whose UUID is the value
- search
perform a case-insensitive search on design names, designer, description, etc.. for substrings matching the value
The following options allow splitting response in multiple shorter chunks:
- start
start response at the given 0-based index, skipping the first designs
- count
limit the number of designs in the response to that count
- paginate_by
split the response in multiple pages of paginate_by designs
- page
include only this page (see paginate_by) in the response
The reponse is formated in JSON and includes a “body” array containing the list of matching designs. Each design include at least the following fields:
- uuid
unique identifier of the design
- name
localized name of the design
- description
localized description of the design
- username
user name of the design’s user
- designername
user name of the design’s owner
- details_link
link to the design’s detail page
- thumbnail_frontview
link to the thumbnail image of the design
Sample Request¶
You can get the list of available materials in JSON format by using the following php:
<?php
$json = file_get_contents("https://www.sculpteo.com/en/api/material/list/" );
echo $json;
?>
» webapi documentation » Querying information » Designs
Last update: 1970-01-01 01:00 (CET)