Configuração de canais

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvel",
              "description": "Canal de venda por aplicativo móvel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Quiosque",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

GET

api

fire

external

channels

config

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvel",
              "description": "Canal de venda por aplicativo móvel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Quiosque",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

Retorna a configuração completa de canais de venda para o seu vendor, enriquecida com dados do catálogo global (uuid, name, description) e os tipos de fulfillment configurados para cada canal. O endpoint não aceita query params. Apenas canais com enabled !== false são retornados. Canais sem match no catálogo são excluídos da resposta.

Autenticação

string

obrigatório

Sua API key do Fire com o scope channels:read. A key deve ser vendor-scoped (account + vendor binding) — keys sem vendorId são rejeitadas com 403. O account e o vendor são resolvidos a partir da key, então não é necessário header account nem query param.

Requisição

GET https://api.fire.rest/api/v1/fire/external/channels/config
x-api-key: <your_api_key>

Resposta

string

UUID do account ao qual a API key pertence.

object[]

Mostrar country

string

ISO 3166-1 alpha-2 (ex. BR, EC, CO).

object[]

Mostrar vendor

string

Identificador do vendor.

string

Nome legível do vendor.

object[]

Mostrar channel

string

UUID do catálogo global de channels.

string

Código do canal (ex. APP, KIOSK, WEB).

string

Nome de exibição.

string | null

Descrição opcional.

boolean

Sempre true nas linhas retornadas.

object[]

Mostrar fulfillmentType

string

UUID do catálogo global de fulfillment_types.

string

Código (ex. DELIVERY, PICKUP).

string

Nome de exibição.

string

Nome interno de referência.

string | null

Descrição opcional.

boolean

Sempre true nas linhas retornadas.

{
  "accountId": "550e8400-e29b-41d4-a716-446655440000",
  "countries": [
    {
      "countryCode": "EC",
      "vendors": [
        {
          "vendorId": "100.1.10",
          "vendorName": "Sandbox Ecuador",
          "channels": [
            {
              "uuid": "9f3a-...-e1",
              "code": "APP",
              "name": "App Móvel",
              "description": "Canal de venda por aplicativo móvel",
              "enabled": true,
              "fulfillmentTypes": [
                {
                  "uuid": "abcf-...-2d",
                  "code": "DELIVERY",
                  "name": "Delivery",
                  "referenceName": "DELIVERY",
                  "description": null,
                  "enabled": true
                }
              ]
            },
            {
              "uuid": "7e2b-...-c8",
              "code": "KIOSK",
              "name": "Quiosque",
              "description": null,
              "enabled": true,
              "fulfillmentTypes": []
            }
          ]
        }
      ]
    }
  ]
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "forbidden",
    "message": "Access denied"
  }
}

Notas

uuid vem do catálogo global de channels, não do JSONB por account.
fulfillmentTypes inclui apenas os tipos configurados para esse canal no vendor. Tipos sem match no catálogo são excluídos.
countries agrupa pelo código de país do JSONB. Um vendor pode aparecer em múltiplos países se tiver configuração por país.

API

APIs de parceiro

PayBridge

Configuração de canais

Autenticação

Requisição

Resposta

Notas

Relacionados

Configuração de métodos de pagamento

Autenticação

​Autenticação

​Requisição

​Resposta

​Notas

​Relacionados

Configuração de métodos de pagamento

Autenticação

Autenticação

Requisição

Resposta

Notas

Relacionados