API Reference

Complete reference documentation for the AS2aaS REST API. This page provides an overview and links to detailed endpoint documentation.

API Documentation Structure

Core API Documentation

API Overview - Base configuration, authentication, data types
Messages API - Send, receive, and track AS2 messages
Partners API - Trading partner management
Master Partners - Account-level shared partner management
Certificates API - X.509 certificate management
Webhooks API - Event notification endpoints
Billing - Account billing and subscription management

Specialized Guides

Message Receiving - Inbound AS2 message handling
Error Handling - Error codes and recovery patterns
Authentication - API key management and security

Quick Reference

Base Configuration

REST API: https://api.as2aas.com
AS2 Receiving: https://as2.as2aas.com/as2/receive
Authentication: Bearer token with API key
Content Type: application/json

Common Endpoints

Operation	Method	Endpoint	Documentation
Send message	POST	`/v1/messages`	Messages API
List messages	GET	`/v1/messages`	Messages API
Get message	GET	`/v1/messages/{id}`	Messages API
List partners	GET	`/v1/partners`	Partners API
Create partner	POST	`/v1/partners`	Partners API
Test partner	POST	`/v1/partners/{id}/test`	Partners API
List certificates	GET	`/v1/certificates`	Certificates
Upload certificate	POST	`/v1/certificates`	Certificates
Create webhook	POST	`/v1/webhook-endpoints`	Webhooks

Authentication Example

GET /v1/partners HTTP/1.1
Host: api.as2aas.com
Authorization: Bearer pk_live_your_api_key
Content-Type: application/json
Accept: application/json

Response Format

{
  "message": "Operation successful",
  "data": {
    "id": "resource_id",
    "attribute": "value"
  }
}

Resource Identifiers

ID Formats

Resource	Prefix	Format	Example
Tenant	`tnt_`	6 digits	`tnt_000001`
Partner	`prt_`	6 digits	`prt_000001`
Message	`msg_`	6 digits	`msg_000001`
Certificate	`cert_`	6 digits	`cert_000001`
API Key	`key_`	6 digits	`key_000001`
Webhook	`wh_`	6 digits	`wh_000001`

HTTP Status Codes

Status	Usage	Description
200	Success	Request completed successfully
201	Created	Resource created successfully
202	Accepted	Asynchronous operation accepted
400	Bad Request	Invalid request parameters
401	Unauthorized	Authentication required
403	Forbidden	Insufficient permissions
404	Not Found	Resource does not exist
422	Validation Error	Request validation failed
429	Rate Limited	Too many requests
500	Server Error	Internal server error

Rate Limits

Limits by Plan

Plan	Requests/Minute	Burst Limit
Free	100	20
Starter	300	60
Professional	1,000	200
Enterprise	Custom	Custom

Rate Limit Headers

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 299
X-RateLimit-Reset: 1705320600

Error Response Format

{
  "message": "Human-readable error description",
  "errors": {
    "field_name": ["Specific validation error"]
  },
  "error": {
    "type": "error_category",
    "code": "SPECIFIC_ERROR_CODE",
    "details": {
      "additional": "context"
    }
  }
}

Getting Started

Register: Create account with registration code
API Key: Generate test API key in dashboard
Partner: Create your first trading partner
Message: Send your first test message
Webhooks: Configure event notifications

For detailed getting started instructions, see the Quick Start Guide.