☑ External Public API > General Information

This document describes the public API Product-Live, intended for project managers and developers to build and automate technical and business processes for end users and with third party systems.

Why V1?

We mention here that this is the first iteration of this API because of the authentication strategy that was selected for this first iteration. The API Key authentication strategy is considered to be one of the simplest to implement/handle, but should only be considered for handling low or non-sensitive data.

About the future of this API:

• Propose an authentication flow based on the OAuth 2.0 framework
• Deprecate the API presented below

Available entities

WARNING

The following API entities are currently in and should not be used in a production environment.

• Account
• Audit Log
• Comment Thread
• Comment Thread Subscriber
• Field
• FIeld Value
• File
• Item
• Item Link
• Job
• Job Execution
• Level
• Matrix Field
• Partition
• Project
• Publication
• Screen
• Screen Column
• Screen Section
• Section
• Suggestion
• Table
• Task
• Task Execution
• User
• Variable

Endpoints

Requests to the API are necessarily made through the https protocol.

Environment	URL	Swagger	OpenAPI JSON definition
Production	https://api.product-live.com/	Swagger	OpenAPI
Staging	https://api.stage.product-live.com/	Swagger	OpenAPI
Dev	https://api.dev.product-live.com/	Swagger	OpenAPI

Versioning

API versioning enables Product-Live to evolve its platform consistently, while providing third-party developers with a reliable roadmap for feature enhancements and deprecations.

To stay informed about upcoming API modifications, we recommend following our Release Notes. Product-Live ensures full backward compatibility of its API within a major version.