# Gateman

Gateman is a hosted credential handler, provider proxy, and narrowly scoped provider-provisioning service for application integrations.

Gateman Contract v1. The intended first public server release is 1.0.0; Gateman has not yet publicly released a server version.

Every listed documentation page has a Markdown representation at the corresponding .md URL.

Public documentation:

## Start here
- What is Gateman?: https://docs.getgateman.com/what-is-gateman/
  Markdown: https://docs.getgateman.com/what-is-gateman.md
  Description: Authoritative product model covering application identity, credential custody, provider access, provisioning, direct-provider patterns, operational boundaries, and deliberate non-goals.
- GetGateman for WordPress: https://docs.getgateman.com/wordpress/
  Markdown: https://docs.getgateman.com/wordpress.md
- Getting started with an application: https://docs.getgateman.com/getting-started-with-an-application/
  Markdown: https://docs.getgateman.com/getting-started-with-an-application.md

## Core contract
- Gateman Contract v1: https://docs.getgateman.com/contract-v1/
  Markdown: https://docs.getgateman.com/contract-v1.md
- Authentication and signing: https://docs.getgateman.com/authentication/
  Markdown: https://docs.getgateman.com/authentication.md
- Environments: https://docs.getgateman.com/environments/
  Markdown: https://docs.getgateman.com/environments.md
- Errors and responses: https://docs.getgateman.com/errors-and-responses/
  Markdown: https://docs.getgateman.com/errors-and-responses.md
- Versioning: https://docs.getgateman.com/versioning/
  Markdown: https://docs.getgateman.com/versioning.md

### Canonical clients
- PHP: https://docs.getgateman.com/canonical-client-php/
  Markdown: https://docs.getgateman.com/canonical-client-php.md
- Node.js: https://docs.getgateman.com/canonical-client-node/
  Markdown: https://docs.getgateman.com/canonical-client-node.md
- Python: https://docs.getgateman.com/canonical-client-python/
  Markdown: https://docs.getgateman.com/canonical-client-python.md
- Go: https://docs.getgateman.com/canonical-client-go/
  Markdown: https://docs.getgateman.com/canonical-client-go.md

## Capabilities

### Email
- Send email: https://docs.getgateman.com/capabilities/email.send/
  Markdown: https://docs.getgateman.com/capabilities/email.send.md

### SMS
- Send SMS: https://docs.getgateman.com/capabilities/sms.send/
  Markdown: https://docs.getgateman.com/capabilities/sms.send.md

### Credentials and configuration
- Access stored credentials: https://docs.getgateman.com/capabilities/secrets.read/
  Markdown: https://docs.getgateman.com/capabilities/secrets.read.md
- Public configuration: https://docs.getgateman.com/public-configuration/
  Markdown: https://docs.getgateman.com/public-configuration.md
- Read database passwords: https://docs.getgateman.com/capabilities/database-password.read/
  Markdown: https://docs.getgateman.com/capabilities/database-password.read.md

### Anti-bot verification
- Verify bot protection: https://docs.getgateman.com/capabilities/anti_bot.verify/
  Markdown: https://docs.getgateman.com/capabilities/anti_bot.verify.md

### Payments
- Use Stripe: https://docs.getgateman.com/capabilities/stripe.use/
  Markdown: https://docs.getgateman.com/capabilities/stripe.use.md
- Use Square: https://docs.getgateman.com/capabilities/square.use/
  Markdown: https://docs.getgateman.com/capabilities/square.use.md
- Use PayPal: https://docs.getgateman.com/capabilities/paypal.use/
  Markdown: https://docs.getgateman.com/capabilities/paypal.use.md
- Read Stripe webhook secret: https://docs.getgateman.com/capabilities/stripe.webhook.read/
  Markdown: https://docs.getgateman.com/capabilities/stripe.webhook.read.md

### Storage
- Use S3: https://docs.getgateman.com/capabilities/s3.use/
  Markdown: https://docs.getgateman.com/capabilities/s3.use.md
- Use Cloudflare R2: https://docs.getgateman.com/capabilities/r2.use/
  Markdown: https://docs.getgateman.com/capabilities/r2.use.md

### Provider relays
- Use the general AWS API relay: https://docs.getgateman.com/capabilities/aws.use/
  Markdown: https://docs.getgateman.com/capabilities/aws.use.md
- Use the general Cloudflare API relay: https://docs.getgateman.com/capabilities/cloudflare.use/
  Markdown: https://docs.getgateman.com/capabilities/cloudflare.use.md

## Provisioning
- Manage Stripe webhook: https://docs.getgateman.com/capabilities/stripe.webhook.write/
  Markdown: https://docs.getgateman.com/capabilities/stripe.webhook.write.md
- Configure managed S3 access: https://docs.getgateman.com/capabilities/s3.provisioning/
  Markdown: https://docs.getgateman.com/capabilities/s3.provisioning.md
- Provision Amazon SES: https://docs.getgateman.com/capabilities/ses.provisioning/
  Markdown: https://docs.getgateman.com/capabilities/ses.provisioning.md

## Operational reference
- Operation Accounting: https://docs.getgateman.com/operation-accounting/
  Markdown: https://docs.getgateman.com/operation-accounting.md
- Rate limits and concurrency: https://docs.getgateman.com/rate-limits-and-concurrency/
  Markdown: https://docs.getgateman.com/rate-limits-and-concurrency.md
- Idempotency: https://docs.getgateman.com/idempotency/
  Markdown: https://docs.getgateman.com/idempotency.md
- Webhooks and event handling: https://docs.getgateman.com/webhooks-and-event-handling/
  Markdown: https://docs.getgateman.com/webhooks-and-event-handling.md
- Data retention: https://docs.getgateman.com/data-retention/
  Markdown: https://docs.getgateman.com/data-retention.md
- Teams and access management: https://docs.getgateman.com/teams-and-access-management/
  Markdown: https://docs.getgateman.com/teams-and-access-management.md
- Security overview: https://docs.getgateman.com/security-overview/
  Markdown: https://docs.getgateman.com/security-overview.md
- Removing Gateman: https://docs.getgateman.com/removing-gateman/
  Markdown: https://docs.getgateman.com/removing-gateman.md

## AI-assisted development
- Using Gateman with coding agents: https://docs.getgateman.com/using-gateman-with-coding-agents/
  Markdown: https://docs.getgateman.com/using-gateman-with-coding-agents.md
- Bootstrap context: https://docs.getgateman.com/bootstrap-context/
  Markdown: https://docs.getgateman.com/bootstrap-context.md
- AGENTS.md integration: https://docs.getgateman.com/agents-md-integration/
  Markdown: https://docs.getgateman.com/agents-md-integration.md