> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.hydrahub.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução à API

> Comece a integrar com o HYDRA HUB

# API do HYDRA HUB

A API do HYDRA HUB é uma solução completa de processamento de pagamentos que permite integrar múltiplas formas de pagamento em sua aplicação de forma rápida e segura. Nossa plataforma oferece suporte para cartão de crédito, PIX e outros métodos de pagamento, com foco em segurança, escalabilidade e facilidade de uso.

## Visão Geral

<Card title="Processamento simplificado de pagamentos" icon="credit-card" iconType="duotone">
  O HYDRA HUB facilita a coleta, processamento e gerenciamento de pagamentos online, permitindo que você foque no crescimento do seu negócio enquanto cuidamos da infraestrutura de pagamentos.
</Card>

## Recursos Principais

<CardGroup cols={2}>
  <Card title="Múltiplos métodos de pagamento" icon="wallet">
    Suporte para cartão de crédito, PIX, com mais métodos sendo adicionados regularmente.
  </Card>

  <Card title="Tokenização segura" icon="shield-check">
    Proteja dados sensíveis de cartão através de tokenização, reduzindo escopo de PCI DSS.
  </Card>

  <Card title="Webhooks em tempo real" icon="bell">
    Receba notificações automáticas sobre mudanças no status das transações.
  </Card>

  <Card title="Dashboard completo" icon="chart-mixed">
    Acompanhe transações, visualize relatórios e gerencie sua conta através de um painel intuitivo.
  </Card>
</CardGroup>

## Ambientes

O HYDRA HUB disponibiliza dois ambientes para sua integração:

| Ambiente | URL Base                              | Descrição                                             |
| -------- | ------------------------------------- | ----------------------------------------------------- |
| Sandbox  | `https://sandbox.api.hydrahub.com.br` | Ambiente de testes para desenvolvimento e homologação |
| Produção | `https://api.hydrahub.com.br`         | Ambiente de produção para transações reais            |

<Tip>
  Recomendamos que você sempre teste sua integração no ambiente Sandbox antes de seguir para produção. O ambiente Sandbox simula todas as funcionalidades do ambiente de produção sem processar transações reais.
</Tip>

## Primeiros Passos

Para começar a usar a API do HYDRA HUB, siga estes passos:

1. **Crie sua conta** no [HYDRA HUB](https://dashboard.hydrahub.com.br/signup)
2. **Obtenha suas credenciais** no Dashboard
3. **Explore a documentação** para entender os endpoints disponíveis
4. **Teste no ambiente Sandbox** antes de ir para produção

## Autenticação

A API do HYDRA HUB utiliza dois tipos de autenticação, dependendo da operação:

### Chaves de API

Todas as requisições à API (exceto o endpoint de status) exigem autenticação. Você receberá duas chaves ao se cadastrar:

* **Chave Pública (`pk_`)**: Pode ser exposta no frontend, usada para tokenização
* **Chave Secreta (`sk_`)**: Deve ser mantida segura no backend, usada para todas as outras operações

### Basic Auth

Para a maioria dos endpoints, você deve usar autenticação Basic Auth concatenando sua chave secreta e pública:

```bash
Authorization: Basic c2tfeHh4eDpwa195eXl5
```

Onde `c2tfeHh4eDpwa195eXl5` é a string Base64 de `sk_xxxx:pk_yyyy`.

<Warning>
  Nunca exponha sua chave secreta em código frontend. Ela deve ser usada apenas em ambientes seguros de backend.
</Warning>

## Endpoints Principais

<CardGroup cols={2}>
  <Card title="Status da API" icon="signal" href="/api-reference/endpoint/status">
    Verifique a disponibilidade e saúde da API
  </Card>

  <Card title="Tokenização de Cartão" icon="credit-card" href="/api-reference/endpoint/card-tokenization">
    Tokenize dados de cartão de forma segura
  </Card>

  <Card title="Transações com Cartão" icon="credit-card" href="/api-reference/endpoint/card-transactions">
    Processe pagamentos com cartão de crédito
  </Card>

  <Card title="Transações com PIX" icon="bolt" href="/api-reference/endpoint/pix-transactions">
    Crie pagamentos instantâneos via PIX
  </Card>

  <Card title="Informações da Empresa" icon="building" href="/api-reference/endpoint/company">
    Consulte dados da sua empresa
  </Card>
</CardGroup>

## Fluxo de Integração

Um fluxo típico de integração com o HYDRA HUB segue estas etapas:

<Steps>
  <Step title="Configuração Inicial">
    Obtenha suas credenciais e configure o ambiente
  </Step>

  <Step title="Tokenização (para cartão)">
    Tokenize dados sensíveis do cartão no frontend
  </Step>

  <Step title="Criação da Transação">
    Processe o pagamento usando o token obtido ou via PIX
  </Step>

  <Step title="Confirmação">
    Verifique o status da transação e confirme o pagamento
  </Step>

  <Step title="Notificações">
    Receba webhooks para atualizações de status
  </Step>
</Steps>

## Formato das Requisições e Respostas

A API do HYDRA HUB utiliza o formato JSON para requisições e respostas, com os seguintes padrões:

### Requisições

```bash
POST /api/v1/transactions
Content-Type: application/json
Authorization: Basic c2tfeHh4eDpwa195eXl5

{
  "paymentMethod": "credit_card",
  "amount": 9990,
  "card": {
    "hash": "eyJhbGciOiJIUzI1NiIsInR5cCI..."
  },
  "customer": {
    "name": "João Silva",
    "email": "joao@email.com"
  }
}
```

### Respostas

```json
{
  "success": true,
  "data": {
    "id": 12345,
    "status": "approved",
    "amount": 9990,
    "createdAt": "2023-05-14T10:30:00Z"
  }
}
```

## Suporte

Se você tiver dúvidas ou precisar de ajuda durante a integração, nossa equipe está disponível para auxiliá-lo:

* **Email**: [suporte@hydrahub.com.br](mailto:suporte@hydrahub.com.br)
* **Chat ao vivo**: Disponível no Dashboard do HYDRA HUB
* **Horário de atendimento**: Segunda a Sexta, 9h às 18h (horário de Brasília)

## Próximos Passos

Comece explorando nossa documentação detalhada:

<CardGroup cols={3}>
  <Card title="Guia Rápido" icon="bolt" href="/essentials/quickstart">
    Um guia passo a passo para sua primeira integração
  </Card>

  <Card title="Tokenização de Cartão" icon="shield" href="/api-reference/endpoint/card-tokenization">
    Como tokenizar cartões de forma segura
  </Card>

  <Card title="Webhooks" icon="bell" href="/api-reference/endpoint/transacoes#webhooks">
    Configure notificações automáticas
  </Card>
</CardGroup>