This is a guide only. To access the portal:
Question not answered below? Contact us for support.
What is required to add a product to the Portal?
Read here the different item types and requirements, and how to create and manage them.
What types of makeup products can we add in the Portal?
The native product categories supported are described here:
lipstick
lipliner
eyebrow
eyeliner
mascara
eyeshadow
foundation
concealer/highlighter
blusher
bronzer
However, it is possible to use 'Looks' to display combined product types (i.e. contour palette), but requires advanced knowledge of the data structure and how to integrate into your application to achieve that
Can I bulk upload products or Looks?
This is a feature in the Portal now, however it is a bit difficult to use unless you really know the data structure. Bulk uploading all the products sometimes isn't the best approach either, and it's faster to create 'presets' and then duplicate as you go. You could also use the Portal for rendering data only and utilise your own database/CMS for product data, localisation, images, and tagging/logic. You would just need to upload products with a unique identifier that matches your own database for reference.
If you need help please do contact us for support.
What masks (shapes) are available and what are their identifiers?
We have a variety of masks. Some makeup categories only have 1 (the best available), while others are more dependent on shape (eyeliners, mascaras, eyeshadows in particular). You can see more about masks in the individual product shade pages.
For those categories, we have multiple types that cover most products and have a recognisable name ('eyeliner_cateye', 'mascara_extra long') If you have an idea for a product shape you want to achieve, we could advise you on the specific mask shape to use, or let you know if that is unachievable, or if it requires a new mask to be made which we could provide.
What are the restrictions on displaying multiple products or masks at the same time?
i.e.: For example : if one mask lines upper eyelid and another lines lower eyelid, both can be simultaneously applied. However if one mask is a thinner line for upper lid, how would the system know to apply only one mask on the upper eyelid?
See above questions about masks first.
Every product category only allows 1 product item being rendered at 1 time. If you apply an eyeliner and eyeshadow, they are separate categories so won't interfere. If you try to apply 2 eyeliners at the same time, for example, it will apply the last one referenced and you will only see that rendered out on a face. This is the case when using product groups (Looks), or if you try to manually override this with FaceSDK.
Each product category is limited in how it can be calibrated by the provided Portal settings in the 'Edit' tabs. Most product types (eyeliners for example) only allow 1 colour calibration, so only 1 eyeliner colour can be applied at any time. You could duplicate that eyeliner with 2 colours so that eyeliner1 = colour 1 and eyeliner2 = colour 2, but you can never show them on a face at the same time. Eyeshadow allows 1-3 colours at the same time, meant for when you have a multi-colour palette.
There are very advanced ways around some of these limitations, but is not advised generally speaking as it may block other categories from being used, overcomplicate the data for future maintenance/updates to product assortment, and cause issues with integration into applications.
Can you switch masks in an application?
ex: Once a SKU is calibrated, does it have to be recalibrated for any new mask type? For example : we calibrate 10 eyeliners with a simple over eyelid application mask. Now we want to do winged tip for all 10 skus, do we have to recalibrate 10 times? Or just get the winged tip mask created?
All products in every product category will have, by default, their specified mask (shape). This could be considered a default mask. If you want to allow users to try different masks on a single product (1 eyeliner product but 10 masks), you could do either:
A. calibrate the product 1 time, and ensure all masks you want to use are in the Portal. You could then allow switching of the masks. Developers of the application will need to create logic for this and attach to UI somehow. This keeps the data and UX/UI simpler (just need some buttons to switch masks) but in the calibration process you will need to check the item against every mask to ensure they are acceptable
B. calibrate the product 10 times changing only the default mask for each one. In a basic mirror UX/UI this would mean you would have 10 products that may look virtually the same (same SKU, same image), but you could differentiate by changing the name that appears in the UI. More complicated UX/UIs could segment the products displayed, but requires far more work. This increases data for maintenance but allows fine-tune control over each individual product if you wish, but also requires extra work depending on the UX/UI.
Is there a key or token for applications to securely access the Beauty Portal API?
Once you provide an email address, we'll create a Client ID and then you can access the portal and invite your team.
In the Portal you can generate a token to authenticate with our API in Settings > App Tokens.
How do I enable camera permissions? / My camera isn't appearing?
Why isn't my camera working?
Test your camera in any other app and ensure you've enabled permissions in that browser. Check that no other app or browser window is open (even in the background) that is using the camera. Restart the browser and open the portal in a new window/tab. Check permissions in the browser settings.