boomi 2.1.1

Python SDK for Boomi Platform API - provides programmatic access to Boomi Enterprise Platform functionality.

Boomi Python SDK

A modern, intuitive Python SDK for the Boomi Platform API that makes integration development simple and efficient.

🚀 What is Boomi?

Boomi is a leading cloud-native integration platform that connects applications, data, and people. The Boomi Platform API provides programmatic access to manage integrations, deploy processes, monitor executions, and control platform resources.

📦 Installation

pip install boomi

⚡ Quick Start

from boomi import Boomi

# Initialize the SDK
client = Boomi(
    account_id="your-account-id",
    access_token="your-api-token"  # or use username/password
)

# List all environments
environments = client.environment.query_environment()
print(f"Found {len(environments.result)} environments")

# Get a specific process component
process = client.component.get_component(component_id="your-process-id")
print(f"Process: {process.name}")

# Execute a process
from boomi.models import ExecutionRequest

execution = client.execution_request.create_execution_request(
    request_body=ExecutionRequest(
        process_id="your-process-id",
        atom_id="your-atom-id"
    )
)
print(f"Execution ID: {execution.request_id}")

🔑 Authentication

The SDK supports multiple authentication methods:

API Token (Recommended)

client = Boomi(
    account_id="your-account-id",
    access_token="your-api-token"
)

Username/Password

client = Boomi(
    account_id="your-account-id",
    username="your-username",
    password="your-password"
)

💡 Tip: Get your API token from the Boomi Platform: Manage → AtomSphere API Tokens

🎯 Key Features

📋 Process Management

• Create, update, and deploy integration processes
• Manage process components and configurations
• Handle process libraries and shared resources

🔄 Runtime Operations

• Execute processes on-demand
• Monitor execution status and logs
• Manage Atom and Molecule runtimes

🌍 Environment Control

• Manage deployment environments
• Handle environment extensions and configurations
• Control environment roles and permissions

👥 Account Administration

• User and role management
• Account configuration
• License and quota monitoring

📊 Monitoring & Analytics

• Execution records and logs
• Performance metrics
• Error tracking and debugging

🔧 Advanced Usage

Async Support

import asyncio
from boomi import BoomiAsync

async def main():
    client = BoomiAsync(
        account_id="your-account-id",
        access_token="your-api-token"
    )
    environments = await client.environment.query_environment()
    print(f"Found {len(environments.result)} environments")

asyncio.run(main())

Custom Timeout

client = Boomi(
    account_id="your-account-id",
    access_token="your-api-token",
    timeout=30000  # 30 seconds (default: 60 seconds)
)

Error Handling

from boomi.net.transport.api_error import ApiError

try:
    process = client.component.get_component(component_id="invalid-id")
except ApiError as e:
    print(f"API Error: {e.status} - {e.message}")

📚 Common Use Cases

Inspect Deployed Packages

# Preferred deployment surface: packaged components and deployed packages
deployed_packages = client.deployed_package.query_deployed_package()

for deployed_package in deployed_packages.result[:5]:
    print(f"Deployment: {deployed_package.id_}")

Monitor Executions

# Query recent executions
executions = client.execution_record.query_execution_record()

for execution in executions.result[:5]:
    print(f"Execution {execution.execution_id}: {execution.status}")

Manage Atoms

# List all atoms
atoms = client.atom.query_atom()

for atom in atoms.result:
    print(f"Atom: {atom.name} - Status: {atom.status}")

🏗️ Architecture

The SDK is organized into logical service modules:

• Component Services: Process, connector, and component management
• Runtime Services: Atom, execution, and deployment management
• Platform Services: Account, environment, and user management
• Monitoring Services: Logs, metrics, and audit trails

Each service provides intuitive methods following REST conventions:

• get_*() - Retrieve single resources
• query_*() - Search and filter resources
• create_*() - Create new resources
• update_*() - Modify existing resources
• delete_*() - Remove resources

🔗 Resources

• Boomi Platform Documentation
• API Reference
• OpenAPI Specification
• SDK Examples

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

⚠️ Requirements

• Python 3.9 or higher
• Active Boomi account with API access
• Valid API token or username/password credentials

---

Built with ❤️ for the Boomi developer community