Skip to Content
SDK 1.14 is out with per-user product usage and typed API errors. Read the changelog →
ReferencePortal

Portal

The Portal is your central hub for managing and monitoring your integration with Squire. Different roles have access to specific functionalities designed for their needs.

  • Product Managers: Access usage statistics and user engagement metrics
  • Support Teams: Manage cases, view logs, and handle troubleshooting
  • Developers: Manage API credentials, environments, and monitor performance

Getting Started

  1. Log in  to the portal using your personal credentials
  2. Invite team members and set their respective role
  3. Contact support if you need additional access or have questions

Managing API keys

Developers can manage API keys within the Portal. API keys are used to create user sessions for initializing the Squire SDK.

Go to the API Keys page in the settings section of the portal.

API keys page in the Squire Portal
API key management in the Portal

Create a new API key

Click the Create API Key button in the top right corner, and fill in the required information:

  • Environment
    • staging: For testing purposes
    • production: For usage with real users
  • Key name: internal name for identification purposes

Securely store the API key

Your API key should be stored as secret. It’s a private key and should never be exposed in any client.

If you disclose your key by any accident, create a new one and revoke access for the old one.

Last updated on