> ## Documentation Index
> Fetch the complete documentation index at: https://docs.spherepay.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Descarga de la Especificación OpenAPI 3.0 de SpherePay

> Descarga la especificación OpenAPI 3.0 de SpherePay para generar clientes API, importar en Postman o Insomnia, o crear integraciones propias.

La API de SpherePay está documentada como una especificación OpenAPI 3.0. La especificación es la fuente de verdad para cada endpoint, esquema de solicitud, esquema de respuesta y código de error — colócala en tu herramienta favorita para generar clientes, importar colecciones o alimentar tus propios servicios internos.

<Card title="Descargar la especificación OpenAPI" icon="file-down" href="/openapi/spherepay.yaml" horizontal>
  <code>spherepay.yaml</code> — OpenAPI 3.0, \~470 KB. El archivo se sirve directamente desde el sitio de documentación y refleja la superficie API publicada más reciente.
</Card>

## Qué contiene la especificación

* Cada endpoint público bajo `/v2/` — clientes, transferencias, cuentas bancarias, billeteras, cuentas virtuales (Onramper Accounts), offloader wallets, representantes empresariales, documentos, due diligence mejorada.
* Esquemas completos de solicitud y respuesta para cada endpoint, incluidas uniones discriminadas para formas de cuenta bancaria específicas de divisas (USD vs. EUR vs. BRL).
* Sobres de error estándar y mapeos de códigos de estado.
* Ejemplos para los cuerpos de solicitud más comunes.

## Usos comunes

<CardGroup cols={2}>
  <Card title="Generar un cliente API" icon="code">
    Alimenta el YAML en [openapi-generator](https://github.com/OpenAPITools/openapi-generator) o [Speakeasy](https://www.speakeasy.com/) para producir un SDK tipado en TypeScript, Python, Go, Java, Ruby y otros.
  </Card>

  <Card title="Importar en Postman o Insomnia" icon="bolt">
    Postman → **Import** → sube el archivo. Obtendrás una colección con todos los endpoints, lista para autenticar con tu clave API.
  </Card>

  <Card title="Validar solicitudes en CI" icon="circle-check">
    Usa [Spectral](https://stoplight.io/open-source/spectral) o cualquier linter compatible con OpenAPI para validar los payloads de solicitud de tu aplicación contra la especificación antes de que lleguen a producción.
  </Card>

  <Card title="Simular la API localmente" icon="server">
    Herramientas como [Prism](https://stoplight.io/open-source/prism) levantan un servidor de simulación local desde la especificación, para que puedas desarrollar contra el contrato de SpherePay sin gastar tráfico de sandbox.
  </Card>
</CardGroup>

## Versionamiento

La especificación rastrea la **API `/v2/` en vivo**. Los cambios que rompen la compatibilidad se anuncian en [Notas de la versión](/es/changelog) antes de que cambie la especificación; los campos deprecados se mantienen en la especificación con `deprecated: true` hasta su eliminación.

Si necesitas fijar una versión histórica específica de la especificación, revisa el historial de Git de este archivo en el repositorio de documentación.

## Problemas con la especificación

Si un campo, tipo o ejemplo no coincide con lo que ves al llamar a la API, eso es un error — escríbenos a [support@spherepay.co](mailto:support@spherepay.co) con el endpoint y una muestra de solicitud/respuesta y corregiremos la especificación.