How-To Guide
This guide will walk you through the essential setup steps for integrating Renumerate with your subscription business.
How To Find Your Brand Private Key
Your Brand Private Key is required for creating handshake tokens that authenticate your users to Renumerate.
Step 1: Access Brand Settings
- Go to studio.renumerate.com
- In the top left corner, click on your brand name to open the dropdown
- Select "Brand Settings" from the dropdown menu
Step 2: Reveal Your Private Key
- Scroll down to the bottom of the Brand Settings page
- Look for the "Reveal Secret Key" button
- Click the button to display your private key
- Copy the key for use in your backend
Step 3: Secure Your Private Key
Security Warning: Your Brand Private Key should be kept secure and never
exposed in client-side code. Always use it only in your backend server environment.
Best practices for key management:
- Store the key in environment variables (e.g.,
RENUMERATE_PRIVATE_KEY) - Never commit the key to version control
- Restrict access to the key to authorized team members only
- Rotate the key periodically for enhanced security
Using Your Private Key
Use your private key to sign handshake tokens on your backend:
import crypto from 'crypto';
const publicKey = process.env.RENUMERATE_PUBLIC_KEY; // pk_live_xxx
const privateKey = process.env.RENUMERATE_PRIVATE_KEY; // sk_live_xxx
function createHandshakeToken(subscriberId) {
const payload = {
brandPub: publicKey,
subscriberId,
timestamp: Date.now(),
nonce: crypto.randomBytes(16).toString('hex'),
};
const payloadBase64 = Buffer.from(JSON.stringify(payload))
.toString('base64url');
const signature = crypto
.createHmac('sha256', privateKey)
.update(Buffer.from(payloadBase64, 'base64url'))
.digest('base64url');
return `${payloadBase64}.${signature}`;
} How To Change Brand Colors
Customize the appearance of your retention flows and subscription hub to match your brand identity.
Step 1: Access Brand Settings
- Go to studio.renumerate.com
- In the top left corner, click on your brand name to open the dropdown
- Select "Brand Settings" from the dropdown menu
Step 2: Customize Your Colors
- Scroll halfway down the Brand Settings page
- You will see the "Colors" section with customizable color options
- Update the colors to match your brand
Step 3: Apply Changes
Instant Updates
All color changes take effect immediately across your retention flows and subscription hub. No additional deployment or configuration is required.
What gets customized:
- Retention Flow modals - Background, buttons, and text colors
- Subscription Hub interface - All UI elements match your brand
- Cancel buttons - Styled according to your color scheme
Color Guidelines
For the best user experience, consider these recommendations:
- Contrast: Ensure sufficient contrast between text and background colors
- Accessibility: Choose colors that are accessible to users with visual impairments
- Brand consistency: Use colors that align with your existing brand guidelines
- Readability: Test colors across different devices and lighting conditions