Connect Shop Data through Open API

Web Level Advanced Role Admin Module Account, Open API About 15 minutes
Updated

Open API helps connect shop data with other apps. Shop admins can create an API key and use the available documentation to prepare a connection that meets their needs.

When to use it:

  • Connecting shop data with another app.
  • Preparing integration access with a developer you trust.

Good to know:

  • Open API is a Premium module.
  • Open API management is available only to shop admins on the web.
  • The Open API menu appears after Asisten AI.
  • An API key is a secret access credential. Do not place it on public pages or share it carelessly.

Before you start

  • Have a shop admin account ready.
  • Make sure the Open API module is active.
  • Identify the data needed by the destination app and arrange who will handle the integration.

Steps

  1. Activate the Open API module

    Open account module management and activate the Premium Open API module for the shop you want to connect. Check the module status before continuing to the shop website.

  2. Open Open API as an admin

    Sign in to the shop website with an admin account, then open Open API. Look for this menu after Asisten AI.

    Open API page on the shop website with module status, usage limits, Dokumentasi API, and Buat kunci baru
    Open Open API on the web using a shop admin account.
  3. Read the provided documentation

    Open the documentation from the Open API page. Match the destination app requirements against the listed services and access instructions. Do not assume all data or actions are available without checking the documentation.

    Open API documentation showing services and access instructions for integration
    Match the destination app requirements against the available documentation.
  4. Create an API key for the connection

    Use the API key creation function on the Open API page and complete the available fields. Store the key securely for use by the destination app. Note: Give the key only to people authorized to work on the connection.

    Open API page with the API key creation function
    Store the API key securely and keep it out of screenshots.
  5. Set up and check the integration

    Add the key to the destination app's secret settings according to the documentation. Check the connection results and data consistency before using it for daily work. Tip: Avoid showing the key in screenshots, group messages, or publicly accessible documents.

What you end up with

The Open API module is active and an API key is available to prepare an integration following the official documentation.

If something goes wrong

The Open API menu is not visible

Make sure the module is active for the correct shop and you are signed in as an admin on the web.

Integration requirements are unclear

Review the documentation with your developer before building the connection. Do not guess the services or access format.

An API key has already been shared

Stop sharing the key and ask an admin to check key handling on the Open API page or through Automan support.