Skip to main content

Introduction

Welcome to Bullitt's Enterprise API​

The e-BSS (Enterprise Business Support System) API provides developers with programmatic access to Bullitt's satellite communication infrastructure. This powerful set of REST endpoints enables you to integrate satellite connectivity directly into your applications, manage your device fleet, monitor usage, and receive real-time event notifications.

What You Can Do With e-BSS API​

The e-BSS API empowers you to:

  • Manage Organisation Hierarchies: Create and manage complex organizational structures with parent-child relationships to reflect your business needs.

  • Provision Satellite Devices: Activate, deactivate, and configure satellite devices programmatically across your organization.

  • Track Communication Data: Access detailed Call Detail Records (CDRs) to analyze communication patterns, troubleshoot connectivity issues, and monitor data usage.

  • Send Downlink Messages: Communicate directly with satellite devices in the field through downlink messaging.

  • Receive Uplink Messages: Configure webhooks to receive instant notifications about device connectivity, messages, and tracking events.

  • Generate Comprehensive Reports: Access detailed analytics and reports on device status and data usage across your organization.

  • Maintain Audit Compliance: Track all administrative actions and configuration changes through detailed audit logs.

Key Concepts​

Before diving into specific API endpoints, it's helpful to understand these core concepts:

Organisation and Fleet Management​

Your satellite device fleet can be organized in a hierarchical structure that mirrors your business organization. Parent organizations can manage and view data from their sub-organizations, allowing for flexible administration and reporting.

Device Lifecycle​

Satellite devices go through several states in their lifecycle - from initial provisioning to activation, operation, and potential deactivation. The API provides endpoints to manage each stage of this lifecycle.

Call Detail Records (CDRs)​

Every satellite communication event generates a Call Detail Record, providing information about the type of communication, data usage, and timing. These records form the foundation for billing, reporting, and analytics.

Event Notifications​

Real-time webhooks allow your systems to receive immediate notifications about important events, such as device connections, message delivery, or tracking updates.

Getting Started​

To begin using the e-BSS API:

  1. Obtain API Credentials: Contact your Bullitt representative to receive your API key.

  2. Explore the Documentation: Browse through our detailed API reference, guides, and examples to understand the available endpoints.

  3. Make Your First API Call: Follow our Quick Start Guide to make your first request to the API.

  4. Integrate with Your Systems: Use our code examples and best practices to build robust integrations.

API Versions​

The current version of the e-BSS API is v1, accessible at the base URL:

https://bss-api.bullitt.com

All API paths described in this documentation should be appended to this base URL.

Next Steps​

We're excited to see what you'll build with the e-BSS API!