Partner Console Features

The Partner Console includes four main sections accessible via the navigation tabs:

1. Secret Keys

Manage your API secret keys with full control over access types and permissions.

Key Features:

• Create New Keys - Generate new API keys with specific access levels
• Key Types:
  • Live - Full read-write access to production data
  • Dryrun - Test write operations without affecting production data (writes are simulated)
  • Read-only - Read-only access for safe data consumption (write operations blocked)
• Key Management - View key details, last used timestamps, rotate keys, and revoke keys instantly
• Key Filtering - Filter keys by status (All, Active, Revoked)
• Key Rotation - Seamlessly rotate keys without downtime

Each secret key displays:

• Label - Customisable name for easy identification
• Key ID - Unique identifier (UUID format)
• Secret - Partially redacted secret key (first 12 and last 4 characters visible)
• Type - Key access level (live, dryrun, read-only)
• Status - Current state (active, revoked)
• Created - Date when the key was generated
• Last Used - Timestamp of most recent API call
• Actions - Rotate or revoke key

2. Integration Settings

Configure how your integration links with Performance Hub facilities.

Key Features:

• Data Linking Method - Choose between two linking methods:
  • Direct Link - Use Performance Hub facility IDs for API calls
  • Linking Identifier - Use your own location identifiers (Branch ID, Store Number, etc.)
  • Learn more about Partner Linking Methods
• Linking Identifier Label - Customise the field name displayed to facilities (e.g., "Branch ID", "Location Code")
• Partner Prefix - Set a unique prefix for your integrations
• Integration Fields - Configure custom fields specific to your integration

3. Partner Details

View and manage your partner profile information.

Editable Fields:

• Partner Email - Primary contact email for notifications
• Description - Brief description of your integration
• Logo URL - URL to your partner logo
• Website - Your company or integration website
• Category - Integration category classification
• Details - Additional partner information

Read-Only Information:

• Partner ID (unique identifier)
• Partner Name
• Integration Status
• Connected Organisations Count

4. Logs

Monitor API activity and troubleshoot integration issues.

Available Data:

• API Request Logs
• Response Status Codes
• Error Messages
• Timestamp Information
• Request/Response Payloads

Connected Organisations

View all organisations that have enabled your integration. Each organisation card displays:

• Organisation Name
• Associated Brands
• Number of Active Facilities
• Integration Status

Ask AI

Get instant help with partner-related topics using the AI assistant (⌘I shortcut).

Ask About:

• API endpoint usage and examples
• Authentication and secret key management
• Data synchronisation best practices
• Troubleshooting common integration issues
• Partner Console features and navigation