Vendor Setup

This guide helps you get started as a lead vendor partner with Ledly.

Overview

As a vendor, you’ll receive:

Portal Access - Login credentials for the vendor portal
API Key - Authentication for lead submission API
Field Mapping - Configuration for your lead data format
Documentation - Integration guides and API reference

Getting Started

Receive Your Credentials

Your organization administrator will:

Create your vendor account in their Ledly instance
Email you portal login credentials
Provide integration documentation

Log In to Vendor Portal

Navigate to the portal URL provided (e.g., https://app.ledly.io/vendor)
Enter your credentials
Complete initial setup (change password, set profile)

Generate API Key

Go to Settings → API Keys
Click Generate New Key
Copy and securely store your API key

🚫

Security Alert: Your API key is shown only once. Store it securely in a password manager or secrets vault. Never share via email or chat.

Configure Integration

Review field requirements with your administrator
Map your lead data to Ledly fields
Set up your submission system

Test Your Integration

Use the sandbox environment first
Submit test leads
Verify leads appear in the portal
Confirm acceptance/rejection behavior

Go Live

Switch to production API key
Update your production endpoint
Begin submitting live leads

Account Information

Portal Access Levels

Level	Capabilities
Viewer	View leads, see reports, download exports
Submitter	Submit leads via API, view submissions
Manager	Manage API keys, configure settings
Admin	Full access including billing

Updating Your Profile

Click your name (top right)
Select Profile
Update your information:
- Display name
- Email (for notifications)
- Notification preferences

Integration Requirements

API Endpoint

Production: https://api.ledly.io/api/leads/inbound
Sandbox:    https://sandbox.api.ledly.io/api/leads/inbound

Required Fields

At minimum, you must provide:

Field	Type	Notes
`email`	string	Valid email format

Recommended Fields

Including these improves lead quality:

Field	Type	Notes
`first_name`	string	Lead’s first name
`last_name`	string	Lead’s last name
`phone`	string	Any format, will be normalized
`source`	string	Your source identifier
`ip_address`	string	Lead’s IP address

Custom Fields

Your organization may require additional fields. Common examples:

program_interest - Desired program
preferred_start - Start date preference
education_level - Current education
years_experience - Work experience

Check with your organization administrator for required and optional custom fields.

Testing Your Integration

Sandbox Environment

Use the sandbox for development and testing:

Setting	Sandbox Value
Endpoint	`https://sandbox.api.ledly.io/api/leads/inbound`
API Key	Your sandbox API key
Data	Test leads only
Retention	Deleted after 24 hours

Test Submission

curl -X POST https://sandbox.api.ledly.io/api/leads/inbound \
  -H "Authorization: Bearer your_sandbox_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "first_name": "Test",
    "last_name": "User",
    "source": "integration-test"
  }'

Verify in Portal

Log in to the vendor portal
Go to Leads → Recent Submissions
Confirm your test lead appears
Check the status and any validation results

Going Live

Pre-Launch Checklist

Before submitting production leads:

Switching to Production

Update your configuration:

Endpoint: https://api.ledly.io/api/leads/inbound
API Key: [Your production key]

Submit a small batch of leads first
Monitor the portal for acceptance/rejection
Scale up gradually

Monitoring & Reporting

Dashboard Metrics

Your vendor dashboard shows:

Metric	Description
Leads Today	Submissions in the last 24 hours
Acceptance Rate	Percentage accepted
Avg Response Time	API response time
Top Rejections	Common rejection reasons

Email Reports

Configure automatic reports:

Go to Settings → Notifications
Enable Daily Summary or Weekly Report
Add email recipients

Reports include:

Lead volume by day
Acceptance/rejection breakdown
Top rejection reasons
Comparison to previous period

Support

Getting Help

For integration support:

Email: [email protected]
Include your vendor ID and request ID

For account issues:

Contact your organization administrator
Email: [email protected]

Common Issues

Issue	Solution
API key not working	Generate a new key; check for spaces
All leads rejected	Review rejection reasons; check field formats
Timeout errors	Implement retry logic; check your network
429 errors	Implement rate limiting; request higher limits

Security Guidelines

As a vendor partner, you must:

Protect API keys - Never expose in code or logs
Use HTTPS only - Never transmit leads over HTTP
Validate consent - Only submit leads with proper consent
Handle PII carefully - Follow GDPR/CCPA requirements
Report incidents - Notify immediately of any breaches

⚠️

Failure to follow security guidelines may result in account suspension.

Overview API Keys