> ## Documentation Index
> Fetch the complete documentation index at: https://wegive.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Bloomerang Setup Requirements

> Prerequisites and requirements for setting up the WeGive Bloomerang integration

# Setup Requirements

Before configuring the WeGive Bloomerang integration, ensure you meet all the necessary prerequisites and have access to the required resources.

## Prerequisites

### Bloomerang Account Requirements

* **Active Subscription**: Valid Bloomerang CRM subscription
* **API Access**: Bloomerang account with API access enabled
* **Administrator Privileges**: Admin-level access to generate API keys
* **Version Compatibility**: Bloomerang API v2 access

### WeGive Account Requirements

* **Organization Admin**: Administrator privileges in your WeGive organization
* **Integration Access**: Access to the WeGive integrations dashboard
* **Billing Status**: Active WeGive subscription with integration features enabled

## Required Information

### From Bloomerang

Gather the following information from your Bloomerang account:

1. **API Key**
   * Generated from Bloomerang Settings → API Access
   * Keep this secure - it provides full access to your Bloomerang data

2. **Default Fund ID**
   * At least one fund must exist in Bloomerang
   * This fund will be used for transactions without specific designations
   * Note the Fund ID from your Bloomerang fund settings

3. **Account Structure**
   * Review existing constituent records
   * Understand your current fund organization
   * Identify any custom fields in use

### From WeGive

Ensure you have:

1. **Organization ID**: Your WeGive organization identifier
2. **Admin Access**: Ability to configure integrations
3. **Data Review**: Understanding of existing donor and transaction data

## API Access Setup

### Generating Bloomerang API Key

1. **Login to Bloomerang**
   * Access your Bloomerang CRM dashboard
   * Ensure you have administrator privileges

2. **Navigate to API Settings**
   * Go to **Settings** → **API Access**
   * If API access is not visible, contact Bloomerang support

3. **Generate New Key**
   * Click **Generate New API Key**
   * Copy the generated key immediately
   * Store securely - this key won't be shown again

4. **Test API Access**
   * Verify the key works by making a test API call
   * Ensure proper permissions are assigned

### API Permissions

Your API key must have access to:

* **Constituents**: Read and write access for donor management
* **Transactions**: Read and write access for donation processing
* **Funds**: Read and write access for designation management
* **Addresses**: Read and write access for contact information

## Data Preparation

### Bloomerang Data Review

Before integration setup:

1. **Clean Existing Data**
   * Remove duplicate constituent records
   * Standardize naming conventions
   * Verify contact information accuracy

2. **Fund Structure**
   * Ensure at least one active fund exists
   * Review fund naming and organization
   * Note fund IDs for mapping purposes

3. **Constituent Categories**
   * Understand individual vs. organization types
   * Review any custom constituent categories in use

### WeGive Data Review

1. **Donor Records**
   * Review existing donor profiles
   * Identify potential duplicates with Bloomerang
   * Prepare for initial matching process

2. **Transaction History**
   * Review donation records that need syncing
   * Understand fund/designation mappings
   * Plan for historical data import if needed

3. **Fund Alignment**
   * Compare WeGive funds with Bloomerang funds
   * Plan fund mapping strategy
   * Identify any new funds needed

## Network and Security

### Firewall Configuration

Ensure your network allows:

* **Outbound HTTPS**: Port 443 to `api.bloomerang.co`
* **API Endpoints**: Access to Bloomerang API v2 endpoints
* **Rate Limiting**: No restrictions on API call frequency

### Security Considerations

1. **API Key Storage**
   * Store API keys securely
   * Rotate keys periodically
   * Monitor API usage for unexpected activity

2. **Data Privacy**
   * Ensure compliance with data protection regulations
   * Review data sharing agreements
   * Understand data residency requirements

3. **Access Control**
   * Limit integration access to necessary personnel
   * Use role-based permissions
   * Maintain audit logs of configuration changes

## Testing Environment

### Recommended Setup

1. **Bloomerang Sandbox**
   * Use Bloomerang test environment if available
   * Create test data for integration validation

2. **WeGive Test Mode**
   * Utilize WeGive's test connection feature
   * Validate configuration before going live

3. **Data Backup**
   * Export current data from both systems
   * Maintain backups before initial sync
   * Document rollback procedures

## Technical Specifications

### API Rate Limits

* **Default Limit**: 1000 requests per hour
* **Burst Capacity**: Short-term higher limits available
* **Retry Logic**: Automatic backoff and retry handling

### Data Volume Considerations

* **Large Datasets**: Plan for longer initial sync times
* **Concurrent Operations**: Understand API concurrency limits
* **Batch Processing**: Leverage batch endpoints for efficiency

### Integration Frequency

* **Real-time Sync**: For critical updates
* **Scheduled Sync**: For bulk operations
* **Manual Triggers**: For testing and recovery

## Validation Checklist

Before proceeding with setup:

* [ ] Bloomerang account has API access enabled
* [ ] API key generated and tested
* [ ] Default fund identified and configured
* [ ] WeGive admin access confirmed
* [ ] Network connectivity verified
* [ ] Data backup completed
* [ ] Security policies reviewed
* [ ] Testing strategy planned

## Common Issues

### API Access Problems

**Issue**: Cannot generate API key

* **Solution**: Contact Bloomerang support to enable API access
* **Check**: Verify account subscription includes API features

**Issue**: API key authentication fails

* **Solution**: Regenerate API key and verify proper copying
* **Check**: Ensure no extra spaces or characters in key

### Data Preparation Issues

**Issue**: No funds exist in Bloomerang

* **Solution**: Create at least one fund before integration setup
* **Check**: Verify fund is active and properly configured

**Issue**: Duplicate constituent records

* **Solution**: Clean duplicates before initial sync
* **Check**: Use Bloomerang's duplicate detection tools

## Next Steps

Once requirements are met:

1. Proceed to [Configuration Options](/bloomerang/configuration-options)
2. Review [Technical Implementation](/bloomerang/technical-implementation)
3. Study [Data Mapping](/bloomerang/data-mapping/overview) details