Skip to main content

How to manage API keys

If you want to build custom integrations or connect external tools to your StoreLinkr data, you can use our REST API. To do this, you'll need to generate a set of API keys.

Generating New Keys​

  1. Navigate to Settings > API Keys.
  2. Click Create New API Keys.
  3. A modal will appear showing your API Token and API Secret.
warning

Save your Secret! The API Secret is only shown once for security reasons. Copy it and store it in a safe place (like a password manager) immediately.

Using the API​

You can find the technical documentation for our public API at: https://api.storelinkr.com/api/doc/public_v2

The API keys you manage in StoreLinkr are required to authenticate with this documentation. You can use your API Token and API Secret directly on the developer portal to test endpoints, explore data structures, and build your custom integrations.

To authenticate your requests manually, you will need to include your Token and Secret in the request headers (X-StoreLinkr-Api-Key and X-StoreLinkr-Api-Secret). See our Authentication documentation for detailed instructions and examples.

Revoking Keys​

If an API key is no longer needed or has been compromised:

  1. Find the key in the list under Settings > API Keys.
  2. Click the Revoke (X) button.
  3. Confirm the action.

Once revoked, any application using those keys will immediately lose access to your StoreLinkr project.

Security Best Practices​

  • Never share your API Secret in public repositories (like GitHub) or with unauthorized personnel.
  • Rotate your keys periodically to maintain a high level of security.
  • Revoke unused keys to minimize the attack surface of your project.