# API Reference Guide

> Use this template to complete reference for [API] endpoints and authentication.

## Template Metadata

| Field | Details |
|-------|---------|
| Category | Technical |
| Owner | [Team or owner] |
| Version | [Version number] |
| Effective Date | [Date] |
| Review Cycle | [Monthly / Quarterly / Annual / Event-based] |
| Status | [Draft / In Review / Approved] |

## Overview

Brief description of the API, its purpose, and core capabilities.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Authentication

Explain authentication methods (API keys, OAuth, JWT). Include code examples for each.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Base URL & Versioning

Document the base URL, versioning scheme, and supported API versions.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Endpoints

For each endpoint group, document: - HTTP method and path - Description - Request parameters (path, query, body) in a table - Request/response examples in code blocks - Status codes

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Error Handling

List error codes, their meanings, and recommended handling.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Rate Limits

Document rate limit policies, headers, and retry strategies.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## SDKs & Examples

Link to SDKs and provide quick-start code examples. Use Markdown with code blocks for all examples. Be precise and complete.

| Item | Details | Owner | Status |
|------|---------|-------|--------|
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |
| [Item or requirement] | [Describe the relevant detail, evidence, or decision] | [Owner] | [Open / Complete] |

### Notes

[Add context, assumptions, exceptions, evidence links, screenshots, calculations, or reviewer comments.]

## Review and Signoff

Document review conclusions, approvals, unresolved items, and next review date.

| Role | Name | Date | Notes |
|------|------|------|-------|
| Preparer | [Name] | [Date] | [Notes] |
| Reviewer | [Name] | [Date] | [Notes] |
| Approver | [Name] | [Date] | [Notes] |