Tejo Developer: Recommendation API

Tags

 

Description:

Send us user information and a picture. We will process it, save it and send you a reccomondation

Steps

  1. login get a token
  2. Collect and send user data using external-skin-tone-detection
  3. Validate skin tone, send updated value for reccomondation
  4. Get recommendation

Send Data: External Skin Tone Detection

POST to this url:

tejo.ca/api/v1/external_skin_tone_detection?_format=json

Use these Parameteres:

NameRequiredValuesDescription
eye ColorNo'Green', 'Hazel', 'Blue', 'Brown'User's eye color
skin_typeNo'Oily', 'Dry', 'Combination'user's skin type
skin_color_correctionNo'Lighter', 'Darker', 'Same'If users want to go a shade lighter or darker
emailNoStringString of user's e-mail
imageYesBase64 encoded imageImage(s) from user-- if multiple images place them side by side.

Response Elements:

NameDescription
skin_toneValule from 0-100 indicating user's skin tone. You can then use this number to validate the skin tone we estimate.
idprovides ID of user's skin profile

 

 

Set Adjustment

In order to get a good reccomondation you should validate the skin tone value given. You can do this by using a gradient slider with numbers from 1-100. Once validated you can get the reccomondation by using this request.

POST to:

 tejo.ca/api/v1/set_adjustment?_format=json/

 

Use these Parameteres:

NameRequiredValuesDescription
idYesintThe id provided from skin tone detection
adjusted_skin_toneNofloatadjusted skin tone color

Response: succes or failure.

Recommendation

Send a GET request to:

tejo.ca/api/v1/reccomondation

Use These Parameteres:

NameRequiredValuesDescription
idyesintThe id provided from skin tone detection
foundationNobooleanshould foundation be included in the reccomondation
concealerNobooleanshould a concealer recommendation be provided
powderNobooleanshould a powder foundation recommendation be provided
face_washNobooleanshould a facewash recommendation be provided.