Skip to main content

How to generate an API key

R
Written by Ronald Lim
Updated over a week ago

Introduction

Eber API Keys enable secure and customisable integration between your systems and the Eber platform.They allow businesses to automate data exchange, streamline workflows, and extend platform capabilities through controlled access. With options to define permissions, set expiry dates, and restrict access by IP, API keys provide both flexibility and security for managing external system connections.

Key Benefits

  • Secure access to Eber's platform features through API integration

  • Flexible permission controls for different API functionalities

  • IP restriction capabilities for enhanced security

  • Custom store mapping for multi-store management

Step by Step Guide

  1. Navigate to Channels in the menu bar and select API

  2. Click the Create button to generate a new API key

  3. Enter the desired API name in the name field

  4. Set the status to either active or inactive

  5. Configure the expiry date (optional)

  6. Set IP restrictions if needed:

    • Choose "IP restricted" to limit access to specific IPs

    • Select "No IP restriction" for unrestricted access

  7. Select permissions for the API key:

    • Loyalty

    • Marketing

    • Messaging

    • Commerce

    • Users

    • Webhook

  8. Choose the default store view (optional)

  9. Set up store connections by linking custom store IDs

  10. Click the Save button to complete the API key creation

  11. To view or copy the API key:

    • Click the Edit button on the created API

    • Locate the API key displayed under the status field

    • Copy the API key for use in your integration

Tips

  • Keep API keys secure and never share them publicly

  • Regularly review and update API permissions

  • Monitor API usage and access patterns

  • Document all API integrations for future reference

Did this answer your question?