API Documentation

This section is designed for REST APIs, provider APIs, shipping APIs, and internal service APIs.

What to document

• Authentication
• Request format
• Response format
• Errors
• Examples
• Rate limits

How to use this section

• Start with the authentication model.
• Add request and response examples next.
• Keep error handling explicit.
• Use the template page when creating new endpoints.