Integrate sizeez exclusively via API calls
This approach doesn't require any of the supporting tools, such as the companion app or the shop plugins. You can integrates sizeez exclusively through API calls, granting complete control over the user interface you wish to present to your users.
This approach is particularly well-suited for sizable teams with dedicated development resources, or when the use case significantly differs from scenarios our supporting tools typically address.
Yes, your developers are required to make adjustments to the code, enabling it to call sizeez APIs and create user interface accordingly.
Step 1: Initiate a scan
To initiate the measurement process, begin by calling the /init
endpoint. Upon a successful response, you'll receive a new job ID.
Save the job ID for later use, we will need it in subsequent steps.
Step 2: Upload 2 Photos
Call the /upload
endpoint with the job ID to receive URLs to upload a front photo and side photo of the user.
Please make sure the photos were taken according to the Photo Taking Guide.
Upload the 2 photos to the URLs with http PUT method.
Once both photos are uploaded, the process will start in the backend.
Step 3: Query state of the scan
After uploading the 2 photos, check the state of scan by calling the /state
endpoint periodically. Once the scan is completed, the state endpoint will return a state of either 2
or -1
. For further details, you can look into the state endpoint documentation. It's important to set interval between each /state
call to prevent excessive server requests; we recommend a interval of 3 to 4 seconds.
Step 4: Get results
As soon as the scan is ready, you can request a result. Call /measurements/{id}
to get the body measurements. Or call /measurements/{id}/recommendation
to get the size recommendation result. Feel free to craft a custom user interface for presenting these results to your store's users, or simply store the outcomes for your internal reference.
A full list of body measurements we deliver can be found here.
You are required to provide a size chart ID to receive size recommendation result. For further details, please refer to: Size Chart