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

# Introdução

> Conecte seu sistema à API pública da Hubfy.

A URL base é `https://api.hubfy.io/v1`. A referência interativa é gerada pelo [OpenAPI canônico](https://docs.hubfy.io/api/v1/openapi.yaml).

**1. Crie uma chave**

Como proprietário, abra **Configurações → Desenvolvedor**, crie uma chave e selecione as permissões necessárias. Copie o segredo completo quando ele for exibido.

**2. Guarde no servidor**

Configure a chave no ambiente seguro da sua integração. Não coloque o segredo em código de navegador, aplicativos distribuídos ou repositórios públicos.

**3. Liste os produtos**

Use uma chave com `read` ou `products:read`:

```bash theme={null}
curl 'https://api.hubfy.io/v1/products?limit=10' \
  -H 'Authorization: Bearer {{API_KEY}}'
```

A resposta contém `object`, `data`, `has_more` e `url`. Uma conta sem produtos retorna `data: []`.

## Criar um produto

Use `write` ou `products:write`. A oferta inicial é criada junto com o produto:

```bash theme={null}
curl 'https://api.hubfy.io/v1/products' \
  -H 'Authorization: Bearer {{API_KEY}}' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: create-product-001' \
  -d '{"initial_price":{"currency":"BRL","unit_amount":19900},"name":"Curso de exemplo"}'
```

O sucesso retorna HTTP `200`. Guarde os IDs retornados; não derive IDs a partir de nomes.

O ambiente atual contém dados reais da conta. A API não expõe `livemode` nem promete um sandbox separado.

## Recursos disponíveis

| Objeto | O que sua integração pode fazer |
| - | - |
| [Produtos](https://docs.hubfy.io/api-reference/products/object.md) | Criar com preço inicial, consultar, atualizar e excluir ou arquivar. |
| [Preços](https://docs.hubfy.io/api-reference/prices/object.md) | Cadastrar ofertas, consultar e administrar condições comerciais conforme o uso. |
| [Arquivos](https://docs.hubfy.io/api-reference/assets/object.md) | Enviar arquivos e vídeos, acompanhar processamento e baixar arquivos prontos. |
| [Clientes](https://docs.hubfy.io/api-reference/customers/object.md) | Administrar o cadastro do cliente. |
| [Pedidos](https://docs.hubfy.io/api-reference/orders/object.md) | Consultar compras e ajustar validade de acesso e metadados. |
| [Links de pagamento](https://docs.hubfy.io/api-reference/payment-links/object.md) | Criar e administrar links de compra hospedados em pay.hubfy.io. |

## Métodos e respostas

Nos payloads e na referência, `id` aparece primeiro; os demais campos seguem ordem alfabética, inclusive dentro de objetos aninhados. A ordem dos itens de arrays é preservada.

Use `GET` para obter e listar, `POST` para criar, atualizar parcialmente e executar ações, e `DELETE` para remover ou desativar. Sucessos retornam HTTP `200`. Cada objeto tem sua visão geral e suas operações na sidebar.

Campos omitidos em uma atualização são preservados. `null` só pode ser enviado onde o campo admite ausência. `metadata`, quando enviado, substitui o objeto inteiro.

As chamadas operam na conta da chave. Chaves, destinos de webhook e histórico de entregas são administrados pelo proprietário no painel; não são operações disponíveis para integrações com chave de API.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.