Portais Liberados

Consulte os portais de integração liberados para uma loja específica.

Endpoint

GET /dealer/{dealer_id}/portal

Método

GET

Parâmetros de URL

Parâmetro	Tipo	Descrição
`dealer_id`	integer	ID da loja

Autenticação

Este endpoint requer autenticação via JWT. Inclua o token no header:

Authorization: Bearer {access_token}

Exemplo de Resposta

Status Code: 200 OK

[
  {
    "id": 1,
    "portal": {
      "id": 5,
      "name": "Webmotors",
      "logo": "https://media.integradordeanuncios.com.br/media/logo/webmotors.webp",
      "has_from_to_brand_car": true,
      "has_from_to_model_car": true,
      "has_from_to_version_car": true,
      "has_from_to_model_by_body_car": false,
      "has_from_to_version_car_by_year": false,
      "has_from_to_brand_motorcycle": false,
      "has_from_to_model_motorcycle": false,
      "has_from_to_version_motorcycle": false,
      "has_from_to_brand_truck": false,
      "has_from_to_model_truck": false,
      "has_from_to_version_truck": false
    },
    "listing_type": [
      {
        "id": 1,
        "name": "Plano Básico",
        "total": 100,
        "published": 50,
        "available": 50,
        "percentage_used": 50.0,
        "integrator_plan_id": 1,
        "is_for_new": false,
        "category": 1,
        "subscription_id": null
      }
    ],
    "category": [1, 2]
  },
  {
    "id": 2,
    "portal": {
      "id": 10,
      "name": "OLX",
      "logo": "https://media.integradordeanuncios.com.br/media/logo/olx.webp",
      "has_from_to_brand_car": false,
      "has_from_to_model_car": false,
      "has_from_to_version_car": false,
      "has_from_to_model_by_body_car": false,
      "has_from_to_version_car_by_year": false,
      "has_from_to_brand_motorcycle": true,
      "has_from_to_model_motorcycle": true,
      "has_from_to_version_motorcycle": true,
      "has_from_to_brand_truck": false,
      "has_from_to_model_truck": false,
      "has_from_to_version_truck": false
    },
    "listing_type": [],
    "category": [2]
  }
]

Estrutura de Dados

A resposta é um array de objetos, onde cada objeto contém:

Campo	Tipo	Descrição
`id`	integer	Identificador único do acesso do portal para a loja
`portal`	object	Objeto com informações do portal (ver abaixo)
`listing_type`	array	Array de objetos com tipos de anúncio/planos disponíveis
`category`	array	Array de inteiros com IDs das categorias habilitadas para o portal (1=Automóvel, 2=Motocicleta, 3=Caminhão, 4=Implemento)

Estrutura do Objeto `portal`

Campo	Tipo	Descrição
`id`	integer	Identificador único do portal
`name`	string	Nome do portal
`logo`	string	URL do logo do portal
`has_from_to_brand_car`	boolean	Indica se suporta de-para de marca para carros
`has_from_to_model_car`	boolean	Indica se suporta de-para de modelo para carros
`has_from_to_version_car`	boolean	Indica se suporta de-para de versão para carros
`has_from_to_model_by_body_car`	boolean	Indica se suporta de-para de modelo por carroceria para carros
`has_from_to_version_car_by_year`	boolean	Indica se suporta de-para de versão por ano para carros
`has_from_to_brand_motorcycle`	boolean	Indica se suporta de-para de marca para motocicletas
`has_from_to_model_motorcycle`	boolean	Indica se suporta de-para de modelo para motocicletas
`has_from_to_version_motorcycle`	boolean	Indica se suporta de-para de versão para motocicletas
`has_from_to_brand_truck`	boolean	Indica se suporta de-para de marca para caminhões
`has_from_to_model_truck`	boolean	Indica se suporta de-para de modelo para caminhões
`has_from_to_version_truck`	boolean	Indica se suporta de-para de versão para caminhões

Estrutura de um Item em `listing_type`

Campo	Tipo	Descrição
`id`	integer	Identificador único do tipo de anúncio
`name`	string	Nome do plano/tipo de anúncio
`total`	integer	Total de anúncios permitidos no plano
`published`	integer	Quantidade de anúncios publicados
`available`	integer	Quantidade de anúncios disponíveis
`percentage_used`	float	Percentual de uso do plano
`integrator_plan_id`	integer	ID do plano no integrador
`is_for_new`	boolean	Indica se é plano para veículos novos
`category`	integer	ID da categoria do plano (pode ser null)
`subscription_id`	integer	ID da assinatura (pode ser null)

Observações

Apenas portais ativos no sistema e ativos para a loja são retornados
Os portais são ordenados alfabeticamente pelo nome
O campo listing_type pode ser um array vazio se não houver planos configurados
O campo category contém os IDs das categorias de veículos que o portal aceita
Os campos has_from_to_* indicam se o portal suporta de-para (mapeamento) para diferentes níveis da hierarquia de veículos

Possíveis Retornos de Erro

401 Unauthorized

Retornado quando o token de autenticação não foi fornecido ou é inválido.

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

{
  "detail": "Token inválido ou expirado."
}

403 Forbidden

Retornado quando o usuário autenticado não tem permissão para acessar este recurso.

{
  "detail": "Você não tem permissão para executar essa ação."
}

400 Bad Request

Retornado quando o parâmetro dealer_id não é fornecido.

{
  "detail": "Parâmetro ID da Loja não encontrado"
}

Endpoint​

Método​

Parâmetros de URL​

Autenticação​

Exemplo de Resposta​

Estrutura de Dados​

Estrutura do Objeto portal​

Estrutura de um Item em listing_type​

Observações​

Possíveis Retornos de Erro​

401 Unauthorized​

403 Forbidden​

400 Bad Request​