APIs Overview

Get Started
Functionality
Learning
Extension
Dev Tooling
APIs
Releases

Essential knowledge

Author:

Fluent Commerce

Changed on:

14 Mar 2024

Overview

Fluent provides both REST and GraphQL APIs. However, REST APIs are limited to specific Platform operations, while the GraphQL API provides the core Domain Model.

Key points

Common Authentication Token: Both Platform REST and Domain GraphQL APIs utilize a shared authentication token, ensuring a unified authentication approach.
Platform REST APIs: Various Platform-level APIs, including Event, Workflow, Job, Plugin, and User Action APIs, are implemented in REST format with version 4.1.
GraphQL API Advantages: The actively supported GraphQL API offers significant benefits over REST, while deprecated Domain-based REST APIs are in maintenance mode for existing clients, with documentation available for reference.

API Authentication

Both the Platform REST and Domain GraphQL APIs use a common Authentication token.See the Authentication docs for more details.

Platform APIs (REST)

Some of our Platform-level APIs are implemented in REST:

Domain APIs (GraphQL)

Our GraphQL API is actively supported and provides significant benefits over REST.See the GraphQL API docs for more details.

Deprecated APIs (REST)

All Domain-based REST APIs are deprecated and only active in maintenance mode for Clients still using them.You can access the Deprecated REST API docs here.

DO NOT USE!

Do not use these APIs for new implementations and integrations. Please refer to the GraphQL API for alternatives.