Ecossistema

Bibliotecas, temas e extensões open source que compõem o ecossistema da HyzePay.

O que é o Ecossistema da HyzePay?

O ecossistema da HyzePay reúne projetos open source oficiais e da comunidade que expandem, facilitam ou personalizam a integração com nossa plataforma de pagamento.

Aqui você encontra desde a CLI e tipos TypeScript até helpers de webhook, coleções REST e schemas para validação em runtime.

O que você encontra no ecossistema

Projetos oficiais: mantidos e suportados pela equipe HyzePay
Projetos da comunidade: criados por desenvolvedores que usam a HyzePay no dia a dia
Ferramentas de DX: CLIs, helpers, mocks, templates e automações
Extensões e plugins: integrações com frameworks, CMSs e plataformas
Tipos e schemas: TypeScript, OpenAPI e Zod para tipagem e validação

Projetos Oficiais

Projetos mantidos diretamente pela equipe da HyzePay, com versionamento, documentação e suporte contínuo.

HyzePay CLI

Oficial

Linha de comando para criar PIX, gerenciar perfis, validar webhooks e automatizar fluxos.

npm i -g @hyzepay/cli

API Types (TypeScript)

Oficial

Tipos TypeScript da API v1 — Payment, erros, webhooks e helpers de resposta.

npm i @hyzepay/api-types

REST / curl recipes

Oficial

Coleção de exemplos REST prontos para Postman, Insomnia e scripts bash.

HMAC Webhooks

Oficial

Snippet e utilitário para validar X-HyzePay-Signature (Stripe-style).

OpenAPI

Oficial

Especificação OpenAPI 3 da API pública v1 para gerar clients e mocks.

Zod schemas

Oficial

Schemas Zod para validar bodies de pagamento e payloads de webhook no runtime.

npm i zod

Projetos da Comunidade

Ainda não listamos projetos da comunidade. Se você publicou um SDK, plugin ou template usando a HyzePay, abra um PR ou fale com o suporte — teremos prazer em destacar.

Nenhum projeto da comunidade ainda — seja o primeiro.

Quer contribuir?

Aceitamos PRs, issues e ideias no repositório. Comece pela CLI ou pelos tipos TypeScript:

# clonar e linkar a CLI local
cd cli
npm link
hyzepay --help

# tipos da API (quando publicados)
npm i @hyzepay/api-types

Sugestões de melhoria também podem ser enviadas pela área de Roadmap no dashboard.

Perguntas Frequentes

Preciso de um SDK para integrar?

Não. A API v1 é REST pura com JSON. Use curl, a CLI ou qualquer HTTP client. Tipos e Zod são opcionais para DX.

Onde fica a documentação da API?

Em Referência → PIX e no arquivo docs/API.md do repositório.

Como reporto um bug na CLI?

Abra uma issue no repositório ou use o suporte do dashboard com o output de hyzepay version e o comando que falhou (sem colar a API Key).