Custom APIs
Custom APIs allow you to extend the capabilities of Commerce. With Custom APIs, you can efficiently manage large, private data sets while benefiting from both simple and complex multidimensional filtering options. Combining Custom APIs with Composer enables you to deploy custom behaviors and integrations, allowing you to implement capabilities unique to your business without having to build and host that functionality from scratch.
A Custom API is composed of one or more Custom Fields and allows you to create Entries. In database terms, a Custom API can be thought of as a table, with fields representing the columns of the table, and entries serving as the database records.
Custom APIs vs Non-Core Flows
Custom APIs are the next generation of Non-Core Flows. Here is a comparison of current features of Non-Core Flows and Custom APIs. This will be updated as we release more capabilities.
| Feature | Non-Core Flows | Commerce Extensions |
|---|---|---|
| Build new APIs | ✅ | ✅ |
| Access Level | Implicit | Client Credentials only |
| Filtering | ⛔️ | ✅ |
| Sorting | ⛔️ | ✅ |
| Events | ⛔️ | ✅ |
| Conditional Updates | ⛔️ | ✅ |
The Custom Fields Overview lists the comparison of different types and validation available in Custom APIs vs Non-Core Flows.
📄️ Create a Custom API
Create a Custom API
📄️ Get all Custom APIs
Get all Custom APIs
📄️ Get a Custom API
Get a Custom API
📄️ Update a Custom API
Update a Custom API
📄️ Delete a Custom API
Delete a Custom API