These integration guides are not official documentation and the Strapi Support Team will not provide assistance with them.

Why Use CommerceLayer

CommerceLayer isn't just another headless commerce platform—it's a scalable solution that integrates effortlessly with your tech stack, including Strapi.

With a comprehensive suite of APIs covering everything from custom pricing to inventory and orders, you can tailor your commerce operations to fit your business model perfectly. This flexibility extends to using Strapi in eCommerce, enabling you to build dynamic, content-rich online stores. The benefits of Strapi in eCommerce include greater control over content and a seamless integration with commerce platforms like CommerceLayer. When choosing a headless CMS, Strapi stands out for its flexibility and robust features, making it an excellent partner for CommerceLayer.

For all the technical details and resources, don't miss the official CommerceLayer documentation.

Why Use Strapi?

Strapi is the leading open-source headless CMS offering features, like customizable APIs, role-based permissions, multilingual support, etc. It simplifies content management and integrates effortlessly with modern frontend frameworks.

Explore the Strapi documentation for more details.

Strapi 5 Highlights

The out-of-the-box Strapi features allow you to get up and running in no time: 1. Single types: Create one-off pages that have a unique content structure. 2. Draft and Publish: Reduce the risk of publishing errors and streamline collaboration. 3. 100% TypeScript Support: Enjoy type safety & easy maintainability 4. Customizable API: With Strapi, you can just hop in your code editor and edit the code to fit your API to your needs. 5. Integrations: Strapi supports integrations with Cloudinary, SendGrid, Algolia, and others. 6. Editor interface: The editor allows you to pull in dynamic blocks of content. 7. Authentication: Secure and authorize access to your API with JWT or providers. 8. RBAC: Help maximize operational efficiency, reduce dev team support work, and safeguard against unauthorized access or configuration modifications. 9. i18n: Manage content in multiple languages. Easily query the different locales through the API. 10. Plugins: Customize and extend Strapi using plugins.

Learn more about Strapi 5 feature.

See Strapi in action with an interactive demo

Explore Strapi in an instant, hands-on demo set up just for you.

• Access Live Demo!

Setup Strapi 5 Headless CMS

We are going to start by setting up our Strapi 5 project with the following command:

🖐️ Note: make sure that you have created a new directory for your project.

You can find the full documentation for Strapi 5 here.

Install Strapi

npx create-strapi-app@latest server

You will be asked to choose if you would like to use Strapi Cloud we will choose to skip for now.

 Strapi   v5.6.0 🚀 Let's create your new project

 
We can't find any auth credentials in your Strapi config.

Create a free account on Strapi Cloud and benefit from:

- ✦ Blazing-fast ✦ deployment for your projects
- ✦ Exclusive ✦ access to resources to make your project successful
- An ✦ Awesome ✦ community and full enjoyment of Strapi's ecosystem

Start your 14-day free trial now!


? Please log in or sign up. 
  Login/Sign up 
❯ Skip 

After that, you will be asked how you would like to set up your project. We will choose the following options:

? Do you want to use the default database (sqlite) ? Yes
? Start with an example structure & data? Yes <-- make sure you say yes 
? Start with Typescript? Yes
? Install dependencies with npm? Yes
? Initialize a git repository? Yes

Once everything is set up and all the dependencies are installed, you can start your Strapi server with the following command:

cd server
npm run develop

You will be greeted with the Admin Create Account screen.

Go ahead and create your first Strapi user. All of this is local so you can use whatever you want.

Once you have created your user, you will be redirected to the Strapi Dashboard screen.

Publish Article Entries

Since we created our app with the example data, you should be able to navigate to your Article collection and see the data that was created for us.

Now, let's make sure that all of the data is published. If not, you can select all items via the checkbox and then click the Publish button.

Enable API Access

Once all your articles are published, we will expose our Strapi API for the Articles Collection. This can be done in Settings -> Users & Permissions plugin -> Roles -> Public -> Article.

You should have find and findOne selected. If not, go ahead and select them.

Test API

Now, if we make a GET request to http://localhost:1337/api/articles, we should see the following data for our articles.

🖐️ Note: The article covers (images) are not returned. This is because the REST API by default does not populate any relations, media fields, components, or dynamic zones.. Learn more about REST API: Population & Field Selection.

So, let's get the article covers by using the populate=* parameter: http://localhost:1337/api/articles?populate=*

Getting Started with CommerceLayer

So, how do you integrate CommerceLayer with Strapi? It's more straightforward than you might think.

Installing CommerceLayer and Adjusting Settings

1. Install the CommerceLayer SDK. From your project's root directory, run:

npm install @commercelayer/sdk

// or

yarn add @commercelayer/sdk

2. Retrieve your CommerceLayer API credentials from your dashboard. In the Strapi Settings panel, you can configure your client ID and secret using environment variables. These variables can be defined in an environment file, such as .env, and accessed in your code to manage configurations across different environments without hardcoding sensitive information.

3. Create custom endpoints in Strapi to communicate with CommerceLayer. You might set up new collections using Strapi’s content-type builder for products, orders, and customers. CommerceLayer handles the ecommerce engine, while Strapi centralizes your content management. Understanding different eCommerce APIs can elevate your online store's functionality.

Code Implementation for Integration

1. Authentication:

import CommerceLayer from '@commercelayer/sdk'

const cl = CommerceLayer({
  organization: 'your-organization-slug',
  accessToken: 'your-access-token'
})

2. Data Synchronization:

const axios = require("axios");

module.exports = {
  beforeCreate: async (model) => {
    // Ensure the API endpoint and data structure are correct before proceeding
    await axios.post("https://api.commercelayer.io/products", model.attributes);
  },
  afterUpdate: async (model) => {
    // Verify the endpoint and inclusion of model.id for successful data update
    await axios.put(
      `https://api.commercelayer.io/products/${model.id}`,
      model.attributes,
    );
  },
};

By integrating CommerceLayer with Strapi, you're setting up a flexible ecommerce environment tailored to your needs. These steps should get you started. As you progress, you can refine and expand your setup to handle more complex scenarios. Always keep security and performance in mind; consider enhancing Strapi security with top security plugins available for developers.

Awesome, great job!

Strapi Open Office Hours

If you have any questions about Strapi 5 or just would like to stop by and say hi, you can join us at Strapi's Discord Open Office Hours Monday through Friday at 12:30 pm - 1:30 pm CST: Strapi Discord Open Office Hours

For more details, visit the Strapi documentation and CommerceLayer documentation.