Partner Portal Guide

Overview

The Partner Portal provides comprehensive tools for managing your team and API keys. This guide will walk you through the essential features to help you get started quickly and securely.

Team Management

Creating Your First Team

1. Access the Partner Dashboard

   • Log into your partner account

   • Navigate to the main dashboard

2. Initialize Your Team

   • Look for the "Create Your Team" card on the dashboard

   • Click the "Create Team" button

3. Configure Team Settings

   • Enter a descriptive team name

   • Add an optional description for context

   • Click "Create Team" to finalize

Inviting Team Members

1. Navigate to Team Management

   • Go to the "Team Members" section from your dashboard

2. Send Invitations

   • Click "Invite Team Member"

   • Enter the member's email address

   • Add a personal message (optional)

   • Click "Send Invitation"

3. Invitation Process

   • Invited members receive an email with an acceptance link

   • They can join your team by clicking the link and following the prompts

Managing Team Roles

Available Roles:

• Owner: Full administrative access

• Admin: Can manage team members and API keys

• Member: Basic access to team resources

Managing Members:

• View all team members in the Team Overview

• Change member roles (Owner/Admin only)

• Remove members from the team

• Monitor member activity

---

API Key Management

Creating API Keys

Important: API keys provide full access to your data. Handle them with care and never share them publicly.

Step-by-Step Creation Process

1. Navigate to API Keys

   • Go to the "API Keys" section in your dashboard

2. Initialize Key Creation

   • Click the "Create API Key" button

3. Configure Your API Key

   • Name: Enter a descriptive name (e.g., "Production App", "Development Testing")

   • Environment: Select either:

     • Development: For testing and development

     • Production: For live applications

   • Expiration: Choose from:

     • Never expires

     • 30 days

     • 90 days

     • 180 days

4. Generate and Secure Your Key

   • Click "Generate API Key"

   • ⚠️ Critical: Copy and save your API key immediately

   • Store it securely - you cannot view it again after this step

Managing Existing API Keys

Viewing Your API Keys

In the API Keys section, you can see:

• Key name and description

• Environment type (Dev/Prod)

• Creation date

• Expiration date

• Last used timestamp

• Usage statistics

Key Management Actions

For each API key, you can:

• View Usage: See detailed usage statistics

• Monitor Activity: Check last used timestamp

• Revoke Key: Immediately disable the key if compromised

API Key Usage Analytics

1. Access Usage Data

   • Click "View Usage" for any API key

2. Available Metrics

   • Total number of requests

   • Usage limits (if configured)

   • Request patterns over time

   • Error rates and status codes

---

Security Best Practices

Team Security

✅ Recommended Practices:

• Create teams for better access control

• Assign appropriate roles based on responsibilities

• Regularly audit team membership

• Remove inactive or departed members promptly

❌ Avoid:

• Sharing individual accounts between team members

• Giving unnecessary administrative privileges

• Leaving inactive members in your team

API Key Security

✅ Recommended Practices:

• Use descriptive, meaningful names for API keys

• Set appropriate expiration dates for enhanced security

• Separate development and production keys

• Monitor API key usage regularly

• Rotate keys periodically

• Store keys in secure environment variables

❌ Avoid:

• Committing API keys to version control

• Sharing keys via email or chat

• Using the same key across multiple environments

• Keeping unused or old keys active

Security Incident Response

If you suspect an API key has been compromised:

1. Immediate Action: Revoke the compromised key immediately

2. Generate New Key: Create a replacement key with a new name

3. Update Applications: Replace the old key in all applications

4. Monitor Usage: Watch for any unusual activity

5. Report: Contact support if you notice unauthorized usage

---

Quick Reference

Team Management Checklist

• [ ] Create your team

• [ ] Invite necessary team members

• [ ] Assign appropriate roles

• [ ] Set up team guidelines

API Key Setup Checklist

• [ ] Create development API key

• [ ] Create production API key (when ready)

• [ ] Store keys securely

• [ ] Configure keys in your applications

• [ ] Set up usage monitoring

---

Need Help?

If you encounter any issues or have questions:

• Check our API Documentation

• Contact our Support Team

• Visit our Community Forum

{% hint style="info" %} Tip: Bookmark this guide for quick reference as you set up and manage your partner account! {% endhint %}