Using the APIs in a nutshell

To provide flexibilities in business integrations and data flow, TG3D Studio offers two libraries of RESTful APIs - the APIConnect and ScanAPI Services for Developers. For those that are not familiar of APIs, you can see them as a library o request commands that you can “send" to the server for it to “return” back the desired results.  These HTTPS data flow are all encrypted with 256-bit encryption.  

The main distinction between the two API libraries are in the purpose and pricing.  ScanAPI is offered for those partners that wish to integrate Cloudzet scan user registration with their own membership creation process or to build their own user interface via an app or web program that can control the Scanatic™ 360 Body Scanner and allows the partner to create an experience catered to their own flow.  ScanAPI is offered for free to our partners.

APIConnect, on the other hand, offers a wide variety of commands to manipulate the data spans across Scanatic™ Body Service, Scanatic™ Nuno3D Service, Scanatic™ StyleBook Service.  The per request cost for different libraries are different:

- Body Service @ US$0.001

- Nuno3D Service (fabrics) @ US$0.0036 and

- StyleBook Service (garments and trims) @ US$0.0046

Each Scanatic™ Body Service comes with up to 1,500 free API requests per month.  Various levels of Scanatic™ Nuno3D Service and Cloudzet Store Web Plug-in packages comes with different amounts of free API requests per month.  For illustration purposes, we will use Scanatic™ Nuno3D Service Pkg 1 (500 free requests / month) and Cloudzet Store Web Plug-in Pkg 1 (500 free requests / month) in the example below.

Let's assume that a customer that has subscribed to Scanatic™ Body Service, Scanatic™ Nuno3D Service Pkg 1, Scanatic™ StyleBook Service and Cloudzet Store Web Plug-in Pkg 1 will in total have the following free monthly API requests credits:

1500 requests x US$0.001 (Body Service) +

500 requests x US$0.0036 (Nuno3D Service) +

500 requests x US$0.0046 (Cloudzet Store Web Plug-in) = US$5.6 

We will then use the following website's user journey from a bespoke tailor as an example:

Page 1:  Display and Customize the suit jacket

Page 2:  Display and Customize the lining for a duit jacket

Page 3:  Display and Customize the trousers for the suit

Page 1:

One this page, a show_garment_by_id API ("get garment”) request is used to obtain the followings:

1) 3D models, the fabric on that model, trims used on that model

2) all available styling options, IDs for all available fabrics that are assigned to this design project, and IDs for all available trims that are assigned to this design project.

a “list fabrics" API request was then used with all the the fabric IDs from "get garment” to download the thumbnails to list on the right and the digital maps for all the fabrics cached in the browser.  A “list fabrics" API request can support up to 100 fabrics per API.  If you have 200 fabrics, it will cost you another Nuno3D Service API request.

Under this scenario, a view to this page will cost 

 “get garment” API x 1 + “list fabrics” x 1 = US$0.0046 (StyleBook Service) + US$0.0036 (Nuno3D Service) = US$0.0082

If you want to enable the trims selections (button, button hole, stitches), then another “list trim” API request will be used will cost another US$0.0046 (StyleBook Service)

US$5.6 - US$0.0046 = US$5.5918 for remaining balance

Also, for each garment that has been shown, it will be stored in the cache up to 7 days for each user session (if the browser is never closed).  Re-visit on the same garment will not cost any additional API requests while the 3D assets are stored in the cache during the user session.  

Page 2:

On this page, since the internal linings model is part of the design project you already get from Page 1, you will not need to “get garment” again.

 

But if you want to list out all available fabrics for the lining, you will need to do another  “list fabrics” API request to get all the fabrics associated to the lining part

 

Total cost for this page:  US$0.0036 (Nuno3D Service) 

US$5.5918 - US$0.0036 = US$5.5882 for remaining balance

Page 3:

One this page, a show_garment_by_id API ("get garment”) request is used to obtain the followings:

1) 3D models for the pants, the fabric on that model, trims used on that model

2) all available styling options, IDs for all available fabrics that are assigned to this design project, and IDs for all available trims that are assigned to this design project.

 

Since it remembers the selected fabric from Page 1, it automatically applies that fabrics over the pants and does not make other fabrics available for selection, it does not need to use “get fabrics” 

 

Toal cost for this page:  US$0.0046 (StyleBook Service).

 

US$5.5882 - US$0.0046 = US$5.5836 for remaining balance

 

 

In total, for a successful add to the shopping cart from Page 1 to Page 3, it costs

 

$0.0082 + $0.0036 + $0.0046 = $0.0164

 

At the end of the billing monthly cycle, if your balance does not go below US$0, you will not be billed.  If it exceeds the free API request credit you have, the system will automatically deduct off the APIConnect balance we have asked you to pre-pay when you subscribe to this service.

For the complete ScanAPI and APIConnect API Documentations, please visit the Scanatic™ for Fashion website -> Menu -> Developer Console.  You will need to make sure your account has Developer permission granted by your Admin.