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

# Verificar a API

> Consulta a identificação da API sem autenticação.



## OpenAPI

````yaml api/v1/openapi.yaml GET /v1
openapi: 3.1.0
info:
  title: Hubfy API
  version: 1.0.0
  description: >-
    API pública da Hubfy para produtos, preços, arquivos, clientes, pedidos e
    links de pagamento. Autenticação por chave da conta. GET consulta; POST
    cria, atualiza ou executa ações; DELETE remove ou desativa. O ambiente usa
    dados reais, sem sandbox separado. Consulte os fundamentos, os objetos e os
    eventos em https://docs.hubfy.io/api-reference/introduction.
servers:
  - url: https://api.hubfy.io
security:
  - apiKeyAuth: []
tags:
  - name: Produtos
    description: Objeto Product. Campos e relacionamentos na visão geral.
  - name: Preços
    description: Objeto Price. Campos e relacionamentos na visão geral.
  - name: Arquivos
    description: Objeto Asset. Campos e relacionamentos na visão geral.
  - name: Clientes
    description: Objeto Customer. Campos e relacionamentos na visão geral.
  - name: Pedidos
    description: Objeto Order. Campos e relacionamentos na visão geral.
  - name: Links de pagamento
    description: Objeto PaymentLink. Campos e relacionamentos na visão geral.
  - name: Fundamentos da API
    description: Conexão e identificação da API.
paths:
  /v1:
    get:
      tags:
        - Fundamentos da API
      summary: Verificar a API
      operationId: getApiHealth
      responses:
        '200':
          description: API disponível
          headers:
            X-Request-Id:
              description: Identifier of this HTTP request
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                additionalProperties: false
                required:
                  - name
                  - version
                properties:
                  name:
                    type: string
                  version:
                    type: string
              example:
                name: Hubfy API
                version: v1
      security: []
components:
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: API key

````

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