Download the PHP package as2aas/php-client without Composer

AS2aaS PHP Client

A comprehensive PHP client library for AS2aaS (AS2 as a Service), designed to simplify AS2 messaging integration for business applications. This library abstracts the complexity of AS2 protocol implementation, enabling developers to integrate secure B2B messaging with just a few lines of code.

Overview

AS2aaS provides a cloud-based AS2 messaging service that handles the complex technical requirements of AS2 protocol implementation. This PHP client library offers a clean, intuitive API for integrating AS2 messaging capabilities into your business applications.

Key Use Cases:

• Healthcare and pharmaceutical supply chain (DSCSA compliance)
• Retail and manufacturing EDI transactions
• Financial services secure document exchange
• Any B2B integration requiring AS2 protocol compliance

Installation

Install the package via Composer:

Laravel Installation

For Laravel applications, the service provider is automatically registered via package discovery. Publish the configuration file:

Add your API key to your .env file:

Quick Start

Laravel Quick Start

Features

• Simple API: Send AS2 messages with minimal code complexity
• Laravel Ready: First-class Laravel integration with service provider and facades
• Enterprise Architecture: Account-based multi-tenant support
• Master Partner Management: Centralized partner configuration with inheritance
• Automatic Security: Built-in signing, encryption, and compression handling
• Real-time Notifications: Webhook integration for message status updates
• Comprehensive Error Handling: Detailed exception management with retry logic
• Content Detection: Automatic EDI, XML, and JSON content type recognition

Configuration

Environment Variables

Configure your API key using environment variables:

Advanced Configuration

Global Configuration

Core Usage Examples

Partner Management

Message Operations

Certificate Management

Webhook Event Handling

Enterprise Features and Tenant Management

Tenant Context Rules

• Account-level modules (accounts, tenants, billing): No X-Tenant-ID header needed
• Tenant-scoped modules (partners, messages, certificates, webhooks): Require X-Tenant-ID header
• Automatic header management: Client automatically adds header based on current tenant context
• Default behavior:
  • Account keys (pk_*): Defaults to first tenant if no tenant set
  • Tenant keys (tk_*): Automatically scoped to their specific tenant

Master Partner Inheritance Flow

The complete 7-step inheritance process:

1. Create Master Partner: Account-level partner creation
2. List Master Partners: View all master partners with inheritance stats
3. Check Inheritance Status: See which tenants inherit which partners
4. Inherit to Tenants: Bulk or individual inheritance with custom settings
5. View Tenant Partners: Combined view of inherited + tenant-specific partners
6. Remove Inheritance: Selective removal from specific tenants
7. Update Master Partner: Changes automatically propagate to inherited partners

Benefits:

• Centralized Management: Create once, inherit everywhere
• Tenant Customization: Override settings per tenant (URL, MDN mode, etc.)
• Automatic Sync: Master partner changes propagate automatically
• Selective Control: Choose which tenants inherit which partners
• Audit Trail: Track all inheritance relationships and changes

Testing

Unit Testing with Mock Client

For unit testing your application without making actual API calls, use the built-in mock client:

Integration Testing with Test Environment

For integration testing against the AS2aaS test environment:

Laravel Testing

Utility Functions

Laravel Integration

Installation

The service provider is automatically registered. Publish the configuration:

Configuration

Add to your .env file:

Usage in Laravel

Webhook Handling in Laravel

Error Handling

The client provides comprehensive error handling with specific exception types:

Multi-Tenant Architecture

AS2aaS supports enterprise multi-tenant architectures where you can manage multiple business entities or customers within a single account:

Account and Tenant Management

Master Partner Inheritance

Create master partners at the account level and inherit them to specific tenants:

Industry-Specific Integration

Healthcare and Pharmaceutical (DSCSA)

The client is designed to support Drug Supply Chain Security Act (DSCSA) compliance requirements:

Testing

Run the test suite:

Run with coverage:

Run static analysis:

Check code style:

API Reference

Client Initialization

• new Client(string $apiKey) - Initialize with API key
• new Client(array $config) - Initialize with configuration array
• Client::createTest(string $apiKey) - Create test environment client
• Client::configure(array $config) - Set global configuration

Core Modules

• partners() - Partner management and lookup
• messages() - Message sending and receiving
• certificates() - Certificate upload and management
• accounts() - Account-level operations (enterprise)
• tenants() - Tenant management and context switching
• webhooks() - Webhook event handling
• billing() - Subscription and usage management
• sandbox() - Testing and development utilities
• partnerships() - Advanced partner onboarding
• utils() - Helper functions and content detection

Requirements

• PHP 8.0 or higher
• Guzzle HTTP client 7.0+
• OpenSSL extension for certificate operations
• JSON extension for API communication

Contributing

Please see CONTRIBUTING for details on our code of conduct and the process for submitting pull requests.

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.

Support

• Documentation: https://docs.as2aas.com
• Support: [email protected]
• Issues: https://github.com/as2aas/php-client/issues

About AS2aaS

AS2aaS is a cloud-based AS2 messaging service that eliminates the complexity of implementing and maintaining AS2 infrastructure. Our platform handles the technical requirements of AS2 protocol compliance while providing a simple, developer-friendly API for integration.

Perfect for businesses requiring secure B2B document exchange, including healthcare organizations needing DSCSA compliance, retail companies managing EDI transactions, and any enterprise requiring AS2 protocol support.