salman/igny8
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Reorg docs

Browse Source
This commit is contained in:
IGNY8 VPS (Salman)
2026-01-08 00:58:28 +00:00
parent 3028db5197
commit 7da3334c03
3 changed files with 2365 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

648
docs/90-REFERENCE/DJANGO-ADMIN-ACCESS-GUIDE.md Normal file
View File

@@ -0,0 +1,648 @@
# Django Admin Access Guide - Payment & Email Integration Settings
**Date:** January 7, 2026
**Purpose:** Guide to configure Stripe, PayPal, and Resend credentials via Django Admin
---
## Table of Contents
1. [Accessing Django Admin](#1-accessing-django-admin)
2. [Integration Providers Settings](#2-integration-providers-settings)
3. [Stripe Configuration](#3-stripe-configuration)
4. [PayPal Configuration](#4-paypal-configuration)
5. [Resend Configuration](#5-resend-configuration)
6. [Plan & Pricing Configuration](#6-plan--pricing-configuration)
7. [Credit Packages Configuration](#7-credit-packages-configuration)
8. [Testing Checklist](#8-testing-checklist)
---
## 1. Accessing Django Admin
### 1.1 URL Access
**Local Development:**
```
http://localhost:8000/admin/
```
**Staging/Production:**
```
https://api.igny8.com/admin/
```
### 1.2 Login
Use your superuser credentials:
- **Username:** (your admin username)
- **Password:** (your admin password)
**Create Superuser (if needed):**
```bash
cd /data/app/igny8/backend
python manage.py createsuperuser
```
---
## 2. Integration Providers Settings
### 2.1 Navigating to Integration Providers
1. Log in to Django Admin
2. Look for **"MODULES"** section (or similar grouping)
3. Click on **"System" → "Integration providers"**
**Direct URL Path:**
```
/admin/system/integrationprovider/
```
### 2.2 Pre-seeded Providers
You should see these providers already created:
| Provider ID | Display Name | Type | Status |
|-------------|--------------|------|--------|
| `stripe` | Stripe | payment | Active (sandbox) |
| `paypal` | PayPal | payment | Active (sandbox) |
| `resend` | Resend | email | Active |
| `openai` | OpenAI | ai | Active |
| `anthropic` | Anthropic | ai | Active |
| `google` | Google | ai | Active |
| `runware` | Runware | ai | Active |
| `cloudflare_r2` | Cloudflare R2 | storage | Active |
---
## 3. Stripe Configuration
### 3.1 Getting Stripe Credentials
#### Step 1: Login to Stripe Dashboard
Go to [dashboard.stripe.com](https://dashboard.stripe.com)
#### Step 2: Get API Keys
**Test Mode (Sandbox):**
1. Toggle to "Test mode" in top-right
2. Go to **Developers → API keys**
3. Copy:
- **Publishable key** (starts with `pk_test_...`)
- **Secret key** (starts with `sk_test_...`)
**Live Mode (Production):**
1. Toggle to "Live mode"
2. Go to **Developers → API keys**
3. Copy:
- **Publishable key** (starts with `pk_live_...`)
- **Secret key** (starts with `sk_live_...`)
#### Step 3: Configure Webhook
1. Go to **Developers → Webhooks**
2. Click **"Add endpoint"**
3. Enter endpoint URL:
```
Test: https://api-staging.igny8.com/api/v1/billing/webhooks/stripe/
Live: https://api.igny8.com/api/v1/billing/webhooks/stripe/
```
4. Select events to listen for:
- `checkout.session.completed`
- `invoice.paid`
- `invoice.payment_failed`
- `customer.subscription.updated`
- `customer.subscription.deleted`
5. Click **"Add endpoint"**
6. Copy the **Signing secret** (starts with `whsec_...`)
#### Step 4: Create Products and Prices
1. Go to **Products → Add product**
2. Create these products:
**Starter Plan**
- Name: `Starter Plan`
- Description: `Basic plan for small projects`
- Pricing: `$99.00 / month`
- Copy the **Price ID** (starts with `price_...`)
**Growth Plan**
- Name: `Growth Plan`
- Description: `For growing businesses`
- Pricing: `$199.00 / month`
- Copy the **Price ID**
**Scale Plan**
- Name: `Scale Plan`
- Description: `For large enterprises`
- Pricing: `$299.00 / month`
- Copy the **Price ID**
### 3.2 Adding to Django Admin
1. Go to Django Admin → **System → Integration providers**
2. Click on **"stripe"**
3. Fill in the fields:
```
Provider ID: stripe (already set)
Display name: Stripe (already set)
Provider type: payment (already set)
API key: pk_test_xxxxxxxxxxxxx (or pk_live_ for production)
API secret: sk_test_xxxxxxxxxxxxx (or sk_live_ for production)
Webhook secret: whsec_xxxxxxxxxxxxx
API endpoint: [leave empty - uses default]
Config (JSON):
{
"currency": "usd",
"payment_methods": ["card"],
"billing_portal_enabled": true
}
✅ Is active: Checked
✅ Is sandbox: Checked (for test mode) / Unchecked (for live mode)
```
4. Click **"Save"**
### 3.3 Update Plan Models with Stripe Price IDs
1. Go to Django Admin → **Auth → Plans**
2. Edit each plan:
**Starter Plan:**
- Stripe price id: `price_xxxxxxxxxxxxx` (from Stripe dashboard)
- Stripe product id: `prod_xxxxxxxxxxxxx` (optional)
**Growth Plan:**
- Stripe price id: `price_xxxxxxxxxxxxx`
**Scale Plan:**
- Stripe price id: `price_xxxxxxxxxxxxx`
3. Save each plan
---
## 4. PayPal Configuration
### 4.1 Getting PayPal Credentials
#### Step 1: Login to PayPal Developer Dashboard
Go to [developer.paypal.com](https://developer.paypal.com)
#### Step 2: Create an App
1. Go to **My Apps & Credentials**
2. Select **Sandbox** (for testing) or **Live** (for production)
3. Click **"Create App"**
4. Enter app name: `IGNY8 Payment Integration`
5. Click **"Create App"**
6. Copy:
- **Client ID** (starts with `AY...` or similar)
- **Secret** (click "Show" to reveal)
#### Step 3: Configure Webhooks
1. In your app settings, scroll to **"WEBHOOKS"**
2. Click **"Add Webhook"**
3. Enter webhook URL:
```
Sandbox: https://api-staging.igny8.com/api/v1/billing/webhooks/paypal/
Live: https://api.igny8.com/api/v1/billing/webhooks/paypal/
```
4. Select event types:
- `CHECKOUT.ORDER.APPROVED`
- `PAYMENT.CAPTURE.COMPLETED`
- `PAYMENT.CAPTURE.DENIED`
- `BILLING.SUBSCRIPTION.ACTIVATED`
- `BILLING.SUBSCRIPTION.CANCELLED`
5. Click **"Save"**
6. Copy the **Webhook ID** (starts with `WH-...`)
#### Step 4: Create Subscription Plans (Optional)
If you want PayPal subscriptions:
1. Go to **Products** in PayPal dashboard
2. Create subscription plans matching your Stripe plans
3. Copy the **Plan IDs**
### 4.2 Adding to Django Admin
1. Go to Django Admin → **System → Integration providers**
2. Click on **"paypal"**
3. Fill in the fields:
```
Provider ID: paypal (already set)
Display name: PayPal (already set)
Provider type: payment (already set)
API key: AYxxxxxxxxxxx (Client ID)
API secret: ELxxxxxxxxxxx (Secret)
Webhook secret: [leave empty - not used by PayPal]
API endpoint:
Sandbox: https://api-m.sandbox.paypal.com
Live: https://api-m.paypal.com
Config (JSON):
{
"currency": "USD",
"webhook_id": "WH-xxxxxxxxxxxxx",
"return_url": "https://app.igny8.com/account/plans?paypal=success",
"cancel_url": "https://app.igny8.com/account/plans?paypal=cancel"
}
✅ Is active: Checked
✅ Is sandbox: Checked (for sandbox) / Unchecked (for live)
```
4. Click **"Save"**
---
## 5. Resend Configuration
### 5.1 Getting Resend API Key
#### Step 1: Login to Resend
Go to [resend.com](https://resend.com)
#### Step 2: Create API Key
1. Go to **API Keys**
2. Click **"Create API Key"**
3. Enter name: `IGNY8 Production` (or `IGNY8 Development`)
4. Select permission: **"Sending access"**
5. Click **"Add"**
6. Copy the API key (starts with `re_...`)
7. **Save it securely** - you won't see it again!
#### Step 3: Verify Your Domain
1. Go to **Domains**
2. Click **"Add Domain"**
3. Enter your domain: `igny8.com`
4. Follow instructions to add DNS records:
- **DKIM Record** (TXT)
- **SPF Record** (TXT)
- **DMARC Record** (TXT)
5. Click **"Verify"**
6. Wait for verification (can take a few minutes to 24 hours)
### 5.2 Adding to Django Admin
1. Go to Django Admin → **System → Integration providers**
2. Click on **"resend"**
3. Fill in the fields:
```
Provider ID: resend (already set)
Display name: Resend (already set)
Provider type: email (already set)
API key: re_xxxxxxxxxxxxx
API secret: [leave empty]
Webhook secret: [leave empty]
API endpoint: [leave empty - uses default]
Config (JSON):
{
"from_email": "noreply@igny8.com",
"from_name": "IGNY8",
"reply_to": "support@igny8.com"
}
✅ Is active: Checked
✅ Is sandbox: Unchecked (Resend doesn't have sandbox mode)
```
4. Click **"Save"**
### 5.3 Testing Email Delivery
After configuring Resend, test email delivery:
```bash
cd /data/app/igny8/backend
python manage.py shell
```
```python
from igny8_core.business.billing.services.email_service import get_email_service
service = get_email_service()
service.send_transactional(
to='your-email@example.com',
subject='Test Email from IGNY8',
html='<h1>Test Email</h1><p>If you receive this, Resend is configured correctly!</p>',
text='Test Email. If you receive this, Resend is configured correctly!'
)
```
---
## 6. Plan & Pricing Configuration
### 6.1 Viewing Plans
1. Go to Django Admin → **Auth → Plans**
2. You should see existing plans:
- Free Plan
- Starter Plan
- Growth Plan
- Scale Plan
- Enterprise Plan
### 6.2 Editing Plan Details
For each plan:
```
Name: Starter Plan
Description: Perfect for small projects
Price: 99.00
Billing period: monthly
Included credits: 5000
Is active: ✅
Stripe price id: price_xxxxxxxxxxxxx (from Stripe dashboard)
Stripe product id: prod_xxxxxxxxxxxxx (optional)
Paypal plan id: P-xxxxxxxxxxxxx (if using PayPal subscriptions)
Feature limits:
Max keywords: 50
Max articles per month: 100
Max team members: 3
Max websites: 1
```
### 6.3 Creating Custom Plans
1. Click **"Add plan"**
2. Fill in all fields
3. Make sure to set:
- ✅ `is_active` = True (to show to users)
- Stripe price ID (from Stripe dashboard)
- Included credits (monthly allocation)
4. Click **"Save"**
---
## 7. Credit Packages Configuration
### 7.1 Viewing Credit Packages
1. Go to Django Admin → **Billing → Credit packages**
2. You should see existing packages:
- Starter: 500 credits @ $9.99
- Value: 2,000 credits @ $29.99
- Pro: 5,000 credits @ $59.99
- Enterprise: 15,000 credits @ $149.99
### 7.2 Editing Credit Packages
For each package:
```
Name: Value Package
Description: Best value for money
Credits: 2000
Price: 29.99
Display order: 2
✅ Is active: Checked
✅ Is featured: Checked (to highlight on UI)
Stripe product id: prod_xxxxxxxxxxxxx (optional - for tracking)
Paypal product id: (optional)
```
### 7.3 Creating Custom Credit Packages
1. Click **"Add credit package"**
2. Fill in:
- Name: e.g., "Black Friday Special"
- Credits: e.g., 10000
- Price: e.g., 79.99
- Description: "Limited time offer!"
3. Check ✅ `is_active`
4. Check ✅ `is_featured` (optional)
5. Click **"Save"**
---
## 8. Testing Checklist
### 8.1 Verify Integration Provider Settings
Go to Admin → **System → Integration providers**
- [ ] **Stripe** - API keys added, webhook secret added, is_active=True
- [ ] **PayPal** - Client ID/Secret added, webhook ID in config, is_active=True
- [ ] **Resend** - API key added, domain verified, is_active=True
### 8.2 Test Stripe Integration
1. **Get Config Endpoint:**
```bash
curl -X GET https://api.igny8.com/api/v1/billing/stripe/config/ \
-H "Authorization: Bearer YOUR_JWT_TOKEN"
```
Should return publishable key and sandbox status
2. **Test Checkout Session:**
- Go to frontend: `/account/plans`
- Select "Stripe" as payment method
- Click "Subscribe" on a plan
- Should redirect to Stripe Checkout
- Complete test payment with card: `4242 4242 4242 4242`
- Should receive webhook and activate subscription
3. **Test Billing Portal:**
- Click "Manage Subscription" button
- Should redirect to Stripe Billing Portal
- Can cancel/update subscription
### 8.3 Test PayPal Integration
1. **Get Config Endpoint:**
```bash
curl -X GET https://api.igny8.com/api/v1/billing/paypal/config/ \
-H "Authorization: Bearer YOUR_JWT_TOKEN"
```
Should return client_id and sandbox status
2. **Test Credit Purchase:**
- Go to frontend: `/account/usage`
- Select "PayPal" as payment method
- Click "Buy Credits" on a package
- Should redirect to PayPal
- Login with sandbox account
- Complete payment
- Should capture order and add credits
### 8.4 Test Email Service
1. **Test Welcome Email:**
```bash
cd /data/app/igny8/backend
python manage.py shell
```
```python
from igny8_core.auth.models import User, Account
from igny8_core.business.billing.services.email_service import send_welcome_email
user = User.objects.first()
account = user.account
send_welcome_email(user, account)
```
Check your inbox for welcome email
2. **Test Payment Confirmation:**
- Complete a test payment (Stripe or PayPal)
- Should receive payment confirmation email
- Check email content and formatting
### 8.5 Test Webhooks
1. **Check Webhook Logs:**
```bash
cd /data/app/igny8/backend
tail -f logs/django.log | grep webhook
```
2. **Trigger Webhook Events:**
- **Stripe:** Complete test checkout, then check webhook logs
- **PayPal:** Complete test payment, then check webhook logs
3. **Verify Webhook Processing:**
- Subscription should be activated
- Credits should be added
- Email notifications should be sent
---
## Quick Reference: Admin URLs
```
# Main sections
/admin/system/integrationprovider/ # All integration providers
/admin/auth/plan/ # Plans and pricing
/admin/billing/creditpackage/ # Credit packages
/admin/billing/payment/ # Payment history
/admin/billing/invoice/ # Invoices
/admin/auth/subscription/ # Active subscriptions
/admin/billing/credittransaction/ # Credit transaction history
# Specific provider configs
/admin/system/integrationprovider/stripe/change/
/admin/system/integrationprovider/paypal/change/
/admin/system/integrationprovider/resend/change/
```
---
## Security Best Practices
### Never Commit API Keys
- ❌ Don't add API keys to code
- ❌ Don't commit `.env` files
- ✅ Use Django Admin to store credentials
- ✅ Use IntegrationProvider model (encrypted in DB)
### Use Environment-Specific Keys
- **Development:** Use Stripe test mode, PayPal sandbox
- **Staging:** Use separate test credentials
- **Production:** Use live credentials ONLY in production
### Regular Key Rotation
- Rotate API keys every 90 days
- Rotate webhook secrets if compromised
- Keep backup of old keys during rotation
### Monitor Webhook Security
- Verify webhook signatures always
- Log all webhook attempts
- Alert on failed signature verification
---
## Troubleshooting
### Stripe Issues
**"No such customer"**
- Check if `stripe_customer_id` is set on Account model
- Clear the field and let system recreate customer
**"Invalid API Key"**
- Verify API key in IntegrationProvider
- Check if using test key in live mode (or vice versa)
**Webhook not working**
- Check webhook URL in Stripe dashboard
- Verify webhook secret in IntegrationProvider
- Check server logs for errors
### PayPal Issues
**"Invalid client credentials"**
- Verify Client ID and Secret in IntegrationProvider
- Make sure using sandbox credentials for sandbox mode
**"Webhook verification failed"**
- Check webhook_id in config JSON
- Verify webhook URL in PayPal dashboard
**Order capture fails**
- Check order status (must be APPROVED)
- Verify order hasn't already been captured
### Resend Issues
**"Invalid API key"**
- Verify API key starts with `re_`
- Create new API key if needed
**"Domain not verified"**
- Check DNS records in domain provider
- Wait up to 24 hours for DNS propagation
- Use Resend dashboard to verify domain status
**Emails not delivered**
- Check Resend dashboard logs
- Verify from_email domain is verified
- Check spam folder
---
## Next Steps
After configuring all providers:
1. ✅ Test all payment flows in sandbox mode
2. ✅ Test email delivery
3. ✅ Verify webhook processing
4. ✅ Test frontend payment gateway selection
5. ✅ Switch to production credentials when ready to go live
For production deployment, update:
- `is_sandbox` = False for Stripe
- `is_sandbox` = False for PayPal
- `api_endpoint` = production URLs
- Use live API keys for all providers
---
**Support:** If you encounter issues, check Django logs:
```bash
cd /data/app/igny8/backend
tail -f logs/django.log
```