# Get started

Learn the API structure and conventions, download the OpenAPI specification, and find the integration essentials.

## OpenAPI specification

The complete API schema is available as a single bundled file. It includes all endpoints, request and response structures, and field definitions. To integrate programmatically, download the specification in the preferred format, instead of parsing the rendered API reference:

YAML
    
JSON
    
## API structure and conventions

The v1 API uses domain-specific base URLs, except for endpoints for managing webhooks and files. Select the correct host for the resource you are working with.

**Base URLs**

Host
Domain
https://pay.solidgate.com/api/v1
Card payments
https://gate.solidgate.com/api/v1
Alternative payment methods
https://subscriptions.solidgate.com/api/v1
Subscriptions
https://payment-page.solidgate.com/api/v1
Payment Page
https://reports.solidgate.com/api/v1
Reports
https://risks.solidgate.com/api/v1
Fraud prevention
https://api.solidgate.com/api/v1/
Webhooks
and 
Files
**Endpoint format**

Endpoints use the action name directly after the base URL. The HTTP method depends on the operation.

```text
{method} {host}/{action}
```

For example, to initiate a card payment:

```bash
POST https://pay.solidgate.com/api/v1/charge
```

**Data formatting**

- **Body:** JSON
- **Content-Type:** `application/json`


For the complete list of endpoints, methods, and parameters, see the Solidgate API reference.

> Using an action with the wrong base URL results in a **Blocked by WAF** (Web Application Firewall) error. For example, the endpoint `/subscription/cancel-by-customer` must be called on `subscriptions.solidgate.com`, not `pay.solidgate.com`.


## Next steps

- [Authentication](https://api-docs.solidgate.com/api/openapi/main/md/authentication): Public and secret keys, required headers, and signature generation.
- [Errors](https://api-docs.solidgate.com/api/openapi/main/md/errors): Error response format, WAF errors, and API logs.
- [Rate limits](https://api-docs.solidgate.com/api/openapi/main/md/rate-limits): API usage limits and retry strategies.
- [Webhook signatures](https://api-docs.solidgate.com/api/openapi/main/md/webhook-signatures): Verify webhooks, handle events, and allowlist outgoing IPs.
- [Backward compatibility](https://api-docs.solidgate.com/api/openapi/main/md/backward-compatibility): Breaking changes and deprecation.


For help, contact us. Stay informed with the Changelog.