API groups

This section allows real-time monitoring of the status of all available REST APIs in Pricelist Server. Each API is listed with its respective endpoint, connection status, and a quick link to the documentation.

At the top, the personal REST key (unique token) is shown, necessary for authenticating to the APIs. ⚠️ Important note: the key is sensitive and must not be shared with unauthorized third parties.

API Table Structure

Each row of the table represents a REST API and contains:

API – Descriptive name of the function (e.g., Get Neutral Items).

Endpoint – Public URL to call for using the API.

Status – Reachability status:

🟢 Online (200) = Endpoint active and functioning

🔴 Error = Endpoint unreachable or in error

Actions – Documentation button, which opens the technical guide of the selected API in Postman.

API groups

Pricelist APIs

They concern the management of items and price lists:

Get Neutral Items – Returns the list of base items.

Get all prices on a given pricelist code – Retrieves all prices associated with a specific pricelist code.

Put Neutral Items – Allows updating or inserting items.

Put Neutral Items Plus – Manages the insertion/update of ArtNeutri Plus fields.

Get Neutral Items Plus – Returns additional data related to items (ArtNeutri Plus).

DeepSpace APIs

Manage models, variants, and options of the DeepSpace configurator:

Get DeepSpace Models – Returns the list of available models.

Get DeepSpace Variants – List of variants linked to the models.

Put DeepSpace Variants – Inserts or updates variants in the system.

Put DeepSpace Options – Inserts or updates options for the variants.

Get DeepSpace Options – Retrieves the complete list of options.

Get DeepSpace associations of the variant option to the models – Returns the associations between variants, options, and models.

Advantages

Immediate monitoring: real-time health status of each endpoint.

Quick access: each API has a direct link to its technical documentation.

Centralized control: a single point to verify the operation of the entire REST system.