> ## 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.

# Download da Especificação OpenAPI 3.0 do SpherePay

> Baixe a especificação OpenAPI 3.0 do SpherePay para gerar clientes de API, importar no Postman ou Insomnia, ou criar ferramentas e integrações personalizadas.

A API do SpherePay está documentada como uma especificação OpenAPI 3.0. A especificação é a fonte de verdade para cada endpoint, esquema de requisição, esquema de resposta e código de erro — importe-a na sua ferramenta favorita para gerar clientes, importar coleções ou alimentar seus próprios serviços internos.

<Card title="Baixar a especificação OpenAPI" icon="file-down" href="/openapi/spherepay.yaml" horizontal>
  <code>spherepay.yaml</code> — OpenAPI 3.0, \~470 KB. O arquivo é servido diretamente do site de documentação e reflete a superfície mais recente da API publicada.
</Card>

## O que está na especificação

* Todos os endpoints públicos sob `/v2/` — clientes, transferências, contas bancárias, carteiras, contas virtuais (Onramper Accounts), offloader wallets, representantes empresariais, documentos, due diligence aprimorada.
* Esquemas completos de requisição e resposta para cada endpoint, incluindo unions discriminadas para formatos de conta bancária específicos por moeda (USD vs. EUR vs. BRL).
* Envelopes de erro padrão e mapeamentos de código de status.
* Exemplos para os corpos de requisição mais comuns.

## Usos comuns

<CardGroup cols={2}>
  <Card title="Gerar um cliente de API" icon="code">
    Alimente o YAML no [openapi-generator](https://github.com/OpenAPITools/openapi-generator) ou no [Speakeasy](https://www.speakeasy.com/) para produzir um SDK tipado em TypeScript, Python, Go, Java, Ruby e outros.
  </Card>

  <Card title="Importar no Postman ou Insomnia" icon="bolt">
    Postman → **Import** → solte o arquivo. Você obterá uma coleção pré-configurada com todos os endpoints, pronta para autenticar com sua chave de API.
  </Card>

  <Card title="Validar requisições no CI" icon="circle-check">
    Use o [Spectral](https://stoplight.io/open-source/spectral) ou qualquer linter compatível com OpenAPI para validar os payloads de requisição da sua aplicação antes de chegarem à produção.
  </Card>

  <Card title="Simular a API localmente" icon="server">
    Ferramentas como o [Prism](https://stoplight.io/open-source/prism) criam um servidor mock local a partir da especificação, para que você possa desenvolver contra o contrato do SpherePay sem consumir tráfego de sandbox.
  </Card>
</CardGroup>

## Versionamento

A especificação acompanha a **API `/v2/` em produção**. Mudanças incompatíveis são anunciadas nas [Notas de versão](/pt-BR/changelog) antes de a especificação ser alterada; campos depreciados são mantidos na especificação com `deprecated: true` até a remoção.

Se você precisar fixar uma versão histórica específica da especificação, verifique o histórico do Git neste arquivo no repositório de documentação.

## Problemas com a especificação

Se um campo, tipo ou exemplo não corresponder ao que você vê ao chamar a API, isso é um bug — entre em contato em [support@spherepay.co](mailto:support@spherepay.co) com o endpoint e uma amostra de requisição/resposta e corrigiremos a especificação.