API Documentation

Comprehensive documentation, guides, and resources to help you integrate with the AegisSphere ecosystem platform.

Quick Start

Get started with the AegisSphere API in just a few steps.

1. Get API Keys

Sign up for a developer account and generate your API keys from the dashboard.

Request Access →

2. Install SDK

Choose your preferred language and install our official SDK.

npm install @aegissphere/sdk

3. Make First Call

Authenticate and make your first API call to get broker information.

View Examples →

API Reference

Complete reference for all available endpoints and their parameters.

Authentication

Secure API access using OAuth 2.0 and JWT tokens

Endpoints

POST/auth/login
POST/auth/refresh
POST/auth/logout

Broker Management

Manage broker profiles, preferences, and network connections

Endpoints

GET/brokers
POST/brokers
PUT/brokers/{id}
DELETE/brokers/{id}

Service Providers

Access and manage service provider information and availability

Endpoints

GET/providers
POST/providers
GET/providers/{id}/availability

Transactions

Handle bookings, payments, and transaction processing

Endpoints

POST/transactions
GET/transactions/{id}
PUT/transactions/{id}/status

Official SDKs

Use our official SDKs to integrate quickly and reliably with your preferred programming language.

JavaScript/Node.js

Full-featured SDK for web and server applications

npm install @aegissphere/sdk
View Documentation →

Python

Python SDK for data analysis and backend integration

pip install aegissphere-sdk
View Documentation →

PHP

PHP SDK for web applications and CMS integration

composer require aegissphere/sdk
View Documentation →

Guides & Tutorials

Step-by-step guides to help you implement common integration patterns and best practices.

Getting Started10 min

Quick Start Guide

Get up and running with the AegisSphere API in 10 minutes

Read Guide
Integration25 min

Broker Integration

Complete guide to integrating broker management features

Read Guide
Integration20 min

Service Provider Onboarding

Step-by-step process for onboarding service providers

Read Guide
Advanced15 min

Webhook Configuration

Set up real-time notifications for your application

Read Guide
Best Practices12 min

Error Handling Best Practices

Robust error handling and retry strategies

Read Guide
Best Practices18 min

Rate Limiting and Optimization

Optimize your API usage and handle rate limits

Read Guide

Need Help?

Our developer support team is here to help you succeed with your integration.