Skip to main content

Magento Backoffice - Setting API Permissions

Learn how to configure the correct API permissions in Magento 2 for the Optiply integration. Covers navigation to the Integrations menu, selecting resources (Sales, Catalogue, Inventory), and specific settings for Magento 2.4.4+.

Carla Domingos avatar
Written by Carla Domingos
Updated this week

πŸ”— Magento 2: Setting API Permissions

To ensure Optiply can sync your products and orders, the API integration in Magento 2 must have the correct permissions (Resource Access).

Step 1: Access Integrations Menu

  1. Log in to your Magento Admin Panel (Backoffice).

  2. Navigate to System β†’ Extensions β†’ Integrations.

Step 2: Edit the Integration

  1. Find the integration you created for Optiply (or the one whose credentials you sent to us).

  2. Click the Edit (pencil) icon next to it.

  3. In the left-hand menu, select API.

Step 3: Configure Resource Access

You have two options for setting permissions:

Option A: Grant All (Recommended)

  • Set Resource Access to All.

  • This ensures that if Optiply adds new features (like syncing shipments or credit memos), the connection will work immediately without re-configuration.

Option B: Custom Permissions

If your security policy requires restricted access, set Resource Access to Custom and check the boxes for at least the following resources:

Resource Group

Specific Node / Path

Sales

Check Orders

Catalog

Check Products

Stores

Navigate to Settings β†’ Configuration β†’ Inventory Section and check Stock Status.

Step 4: Save and Activate

  1. Click Save.

  2. If prompted, you may need to re-authorise the integration to apply the new permissions.

⚠️ Important: Magento 2.4.4 and Newer

If your shop is running on Magento 2.4.4 or a newer version, there is an additional security setting you must check if the connection fails.

In Magento 2.4.4, OAuth access tokens were disabled by default for Bearer authentication.

  1. Go to Stores β†’ Configuration β†’ Services β†’ OAuth.

  2. Open the Consumer Settings section.

  3. Set "Allow OAuth Access Tokens to be used as standalone Bearer access tokens" to Yes.

  4. Flush your Magento Cache (System β†’ Cache Management) for the change to take effect.

If Magento version is 2.4.4:


❓ Frequently Asked Questions (FAQs)

I changed the permissions, but Optiply still can't connect. Why?

After saving changes to an integration, Magento sometimes requires you to click "Re-authorise" or generate new access tokens. Ensure that the Access Token and Access Secret in Optiply match what is currently active in Magento.

Why do you need "Stock Status" permission?

This specific permission allows us to read the configuration settings related to your inventory (e.g., if you use "Manage Stock" or "Backorders"). Without it, we might miscalculate your available stock.

What if I use MSI (Multi-Source Inventory)?

If you use MSI, ensure you also grant permissions related to Inventory Management (often found under Stores β†’Inventory in the resource tree) so we can see stock per source/warehouse.

Did this answer your question?