Pricefx REST API Reference
The Pricefx Backend API
Download OpenAPI description
Overview
URL
Pricefx
Languages
Servers
Mock server
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi
URL:
https://{baseUrl}/pricefx/{partition}
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/token/refresh
- URL:https://companynode.pricefx.com/pricefx/companypartition/token/refresh
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/token/refresh \
-H 'Content-Type: application/json' \
-H 'Pricefx-Key: string' \
-d '{
"refresh-token": "string"
}'Response
application/json
{ "access-token": "string", "refresh-token": "string", "token-type": "string", "expires-in": 0 }
Request
Authenticates a user. When the user is authenticated, the logged-in user's details (including all roles and permissions) are returned in the response body.
CSRF check is not performed by this endpoint, because the user is authenticated using the basic HTTP auth.
Security
basic or X-PriceFx-jwt
object
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/login/extended
- URL:https://companynode.pricefx.com/pricefx/companypartition/login/extended
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/login/extended \
-H 'Content-Type: application/json' \
-d '{}'Response
application/json
{ "response": { "node": "string", "data": [ … ], "status": 0 } }
Query
Set to true to reuse an existing session and avoid unnecessary roundtrips to the IdP. When set to true, if a valid session is detected, the endpoint will directly redirect to the target page as per RelayState without performing an IdP roundtrip. If no session or an expired session is found, the endpoint will perform the IdP roundtrip as usual.
- Mock serverhttps://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/saml/signon
- URL:https://companynode.pricefx.com/pricefx/companypartition/saml/signon
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
'https://api.pricefx.com/_mock/openapi/reference/pricefx-server_openapi/saml/signon?keepSession=true'See the Key-Value Database Storage Knowledge Base article for more details.
Operations
Here you can find all fields of the corresponding entity (represented by the type code).
Use the /metadata.describe endpoint to find out the correct data type of the field that is used in your partition.
Comments