SaaS API Overview

API Overview

Welcome to the SaaS API documentation. This page provides an overview of the API endpoints and their functionalities. Whether you are looking to authenticate, manage user data, or interact with our services, you'll find all the necessary details here.

For detailed API specifications, please refer to our Swagger Documentation.

API Calls

We define as API calls the results of algorithms calculation.

By default Face Skin Metrics 2.0 produces 17 API calls per 1 uploaded image.

Deprecation process

Adoption period: 1 year

  • we add new algorithm (it becomes available for new datasets)

  • we announce that old algorithm is deprecated

  • to adopt the new algorithm, you can do it yourself via API or ask support

  • after everybody has adopted the new algorithm and discarded the old one, the old algorithm is disabled (but don't worry, if you can't adopt the new one during the adoption period, we will still continue hosting the old one until you can adopt the new algorithm)

Authentication

Authentication methods.

Swagger

Contains method for login and private tokens management methods.

Datasets

Collection of subjects (your app users).

Entity documentation

Swagger

Contains datasets management methods: create, list, retrieve, update, delete.

Algorithms

Sets of image processing algorithms, working together.

Entity documentation

Swagger

Contains algorithms applications management methods: list available algorithms applications, attach algorithms applications to datasets.

Subjects

Collection of image batches.

Entity documentation

Swagger

Products recommendations

Recommended products (inventory items) for image.

Entity documentation

Swagger

Metrics and Submetrics

Metrics and Submetrics produced by algorithms.

Swagger

Integrate with external platforms with webhooks

You can create or update webhook here and list webhooks for dataset (only allowed to have 1 per dataset).

Entity documentation

Swagger

Last updated

Was this helpful?