Stripe Setup Guide

This guide helps you configure your Stripe account and obtain your API Key for Codeless Sync. We recommend using a restricted key for enhanced security.

Prerequisites

• An active Stripe account
• Access to your Stripe Dashboard

Step 1: Access API Keys

1. Log in to your Stripe Dashboard
2. Click Developers in the left sidebar
3. Select API keys
4. Click Create Restricted Key
5. Click Providing this key to another website
6. Name the Restricted Key
7. Copy and paste the URL into your URL box
   https://www.codelesssync.com/
8. Do Not tick Customize permissions for this key checkbox
9. Click Create restricted key, the restricted key is now created

Step 2: Understand Environments

Stripe has two environments, which are automatically detected from your API Key:

Test Mode

• Purpose: Development and testing
• Restricted Key: Starts with rk_test_ (Recommended)
• Secret Key: Starts with sk_test_ (Fallback)
• Data: Test data only, no real charges
• When to use: Initial setup, development, staging

Live Mode

• Purpose: Production with real customers
• Restricted Key: Starts with rk_live_ (Recommended)
• Secret Key: Starts with sk_live_ (Fallback)
• Data: Real customer data and charges
• When to use: Production applications only

Step 3: Copy Your API Key

Restricted Key (Recommended)

After creating your restricted key in Step 1:

1. Find your newly created key in the Restricted keys section
2. Click the key to reveal it, or click Copy to copy it directly
3. Store it securely (you'll paste this in Codeless Sync)

Secret Key (Fallback)

If you prefer to use a standard secret key instead:

1. In the API keys page, find the Standard keys section
2. Click Reveal test key (or Reveal live key)
3. Click Copy to copy the key
4. Store it securely

Step 4: Use in Codeless Sync

1. Go to your CLS dashboard
2. Create a new configuration
3. Paste your Stripe API Key in Step 3
4. Click Test Connection
5. Proceed with configuration

Security Best Practices

Use Restricted Keys

For enhanced security when using third-party services like CLS:

• Recommended: Use restricted keys (rk_test_ or rk_live_)
• Fallback: Secret keys (sk_test_ or sk_live_) are supported but not recommended for third-party integrations
• Stripe recommends restricted keys for any service that doesn't need full account access

Rotate Keys Regularly

Rotate your API keys every 90 days (Optional):

1. Generate a new key in Stripe
2. Update all configurations in CLS
3. Delete the old key in Stripe

Monitor Usage

Check your Stripe dashboard regularly for:

• Unexpected API calls
• Failed authentication attempts
• Unusual access patterns

Stripe API Limits

Stripe rate limits API requests:

• Default: 100 requests/second
• Burst: Up to 1000 requests/second for short periods

CLS automatically handles rate limiting with:

• Batch processing
• Request throttling
• Exponential backoff on errors

Testing Your Setup

After adding your Stripe key to CLS:

1. Create a test configuration
2. Run a manual sync
3. Verify data appears in your database
4. Check sync history for any errors

Common Issues

Invalid API Key

• Verify you copied the entire key
• Check you're using the correct environment (test vs live)
• Ensure the key hasn't been deleted in Stripe

Permission Denied

• If using a restricted key, verify it has access to the resources you're syncing
• Check that data exists in Stripe (e.g., you have customers, invoices, etc.)
• Ensure your Stripe account is active

Rate Limit Exceeded

• Reduce sync frequency
• Set up scheduled syncs instead of manual triggers
• Contact Stripe support to increase limits

Next Steps

• Quick Start Guide - Create your first sync
• Configurations - Learn about sync configs
• Troubleshooting - Common issues