Developer Settings¶
The Developer settings provide technical teams, developers, and engineers with the credentials required to integrate Ruby directly into backend services, marketing automation pipelines, and internal tools.
From here, Owners and Admins can create and revoke API keys with granular scopes, choosing between standard Bearer token authentication and cryptographic HMAC-SHA256 request signing.
1. API Keys¶
API keys authenticate programmatic requests to the Public Developer REST API.
Creating an API Key¶
To generate a new API key:
- Navigate to Settings > Developer in the web application.
- Click Create API Key.
- Enter a descriptive Name to identify the application or script using this key (e.g.
Zapier ProductionorMarketing Automation Bot). - Select the Authentication Type:
- Bearer: Standard token-based authentication. Generates a Public Key ID (
ak_...) and Key Secret (as_...). Formatted in requests asAuthorization: Bearer <key_id>:<key_secret>. - HMAC: Cryptographic signature-based request authentication. Generates a Public Key ID (
ak_...) and HMAC Secret (hs_...) used to sign incoming HTTP requests with custom headers (X-Rby-Key-Id,X-Rby-Timestamp,X-Rby-Signature).
- Bearer: Standard token-based authentication. Generates a Public Key ID (
- Assign one or more Scopes (permissions) to limit the key's capabilities:
links:read: Query short links, lookup short codes, download QR codes, and retrieve available domains.links:write: Create, edit, and delete short links, and run batch creations.groups:read: View link groups and download group export files.groups:write: Create, update, and delete link groups.analytics:read: Retrieve aggregated click analytics for links and groups.
- Click Create Key.
- Copy your credentials (Key ID and Secret) immediately and store them securely in a password manager or environment secret store.
Store Secrets Securely
API secrets are displayed only once upon generation. Ruby stores secret hashes securely and cannot retrieve lost secrets. If a secret is lost or compromised, revoke the key immediately and create a new one.
Never Expose API Secrets
API credentials are intended strictly for server-to-server communication. Never expose API secrets in client-side code, mobile applications, web browsers, or public git repositories.
2. Managing Active Keys & Revocation¶
The API Keys table lists all active keys in your organization:
- Key Name: The descriptive identifier assigned at creation.
- Key ID: The public prefix (
ak_...) identifying the credential. - Auth Type: Bearer or HMAC.
- Assigned Scopes: Granular access permissions.
- Created Date: Timestamp when the key was created.
Revoking an API Key¶
If a key is no longer needed or credentials have leaked:
- Locate the key in the API Keys list.
- Click the action menu and select Revoke Key.
- Confirm revocation.
Revocations take effect immediately. Any incoming requests using the revoked key will be rejected with 401 Unauthorized.