This specification describes the JSON-based REST API of the Pricefx backend service ("the backend") to retrieve and manipulate objects, as well as to execute methods. In short, all functionality that the backend offers is exposed by this API.
The default web user interface uses this API as its only communication path to the backend, as well as the provided Excel Client. This document should enable anyone with advanced development skills to write a custom client application – e.g. for integration purposes to a custom system.
Pricefx's REST API documentation contains the following sections:
- Getting Started : In this guide, you will gain a basic understanding of the Pricefx API endpoints for loading and fetching Master Data using the REST API and all necessary information regarding authentication and limits.
- Data Formats and Transport Protocol : Describes the use of JSON as the default data format API calls, the transport protocol, and supported TLS protocol versions for secure connections.
- Authentication : Explains the authentication process for the Pricefx REST API, including how to obtain, and use access tokens.
- Status Codes : Covers the standard HTTP status codes and application-specific status codes used within the Pricefx API.
- Filtering, Sorting, Pagination : Provides methods for managing larger data sets – provides guidance on using filters, sorting, and pagination to optimize your API calls.
- Batching : Explains how to group multiple API calls into a single request, reducing the number of requests and improving performance.
- Compression : About GZIP compression for server responses and LZF compression for request bodies. Describes file size limits.
- API Versions : Describes differences between two API versions and how to use them.
- Pricefx API Reference : Provides a detailed reference of the API endpoints, including their functionalities, request, and response schemas, and examples.
- OpenAPI Reference Files : Allows you to download the latest OpenAPI reference files in YAML or JSON formats.