> ## Documentation Index
> Fetch the complete documentation index at: https://docs.clubfix.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# Obter uma marca pelo ID
> Este recurso obtém uma determinada marca de dispositivo que esteja atribuída ao parceiro autenticado.
O parâmetro include pode ser atribuído neste recurso, com a finalidade de incluir na resposta um dado extra, como exemplificado na tabela abaixo.
| **Parâmetro** | **Descrição** |
| --- | --- |
| models | Anexa à resposta todos os modelos da marca requerida. |
| modelCount | Anexa à resposta a quantidade todal de modelos que a marca requerida possui. |
Corresponde ao ID da marca que você deseja obter. Este ID é único para cada marca e pode ser encontrado na lista de marcas ou em outros endpoints relacionados.
Token de autenticação do tipo Bearer obtido através do endpoint de login.
## OpenAPI
````yaml GET /brands/{brandId}
openapi: 3.0.3
info:
title: Clubfix Webservice de Parceiros
description: >-
Bem vido(a) à documentação do **Webservice de Parceiros** da **Clubfix.** Os
recursos aqui dispostos são suplementados com exemplos de respostas
esperadas, para nortear a implementação. Caso haja algum empecilho ou erro
não esperado, fique à vontade para chamar o suporte em TI pelos canais que
você já conhece.
Observação: Utilize sempre os cabeçalhos `Content-Type` e `Accept` como
`application/json`
#### **URL Base**
| **Ambiente** | **URL** |
| --- | --- |
| Homologação | [https://homolog.clubfix.com.br/webservice]() |
| Produção | [https://clubfix.com.br/webservice]() |
> NOTA: Para conseguir utilizar ambos ambientes, faz-se necessário solicitar
pelo nosso time de suporte a geração das chaves de autenticação mencionadas
na seção de **Autenticação**.
#### Paginação
Para navegar nos recursos de listagem através de suas páginas, utilize as
`parâmeros` dispostas na tabela abaixo
| **Parâmetro** | **Descrição** |
| --- | --- |
| page | Corresponde à pagina que você deseja exibir os dados. |
| per_page | Altera a quantidade de itens devolvidos em uma requisição. |
| current_page | Identifica a pagina correspondente àquela requisição. |
### **Conhecendo os erros comuns**
| **Status Code** | **Descrição** |
| --- | --- |
| 422 | Erro em algum parâmetro fornecido. O resultado deste erro será um
objeto, onde a sua chave indicará o campo que não está em conformidade. |
| 401 | Não autorizado. Significa que há ausência de um token válido na
requisição, seja por expiração, não fornecimento, ou, no caso do login, as
suas credenciais não estão corretas. |
| 5** | Erro de servidor no endpoint requisitado. Quando isso ocorrer,
contate o nosso suporte. |
version: 1.0.0
servers: []
security: []
paths:
/brands/{brandId}:
get:
summary: Obter Marca pelo ID
description: >-
Este recurso obtém uma determinada marca de dispositivo que esteja
atribuída ao parceiro autenticado.
O parâmetro include pode ser atribuído neste recurso, com a finalidade
de incluir na resposta um dado extra, como exemplificado na tabela
abaixo.
| **Parâmetro** | **Descrição** |
| --- | --- |
| models | Anexa à resposta todos os modelos da marca requerida. |
| modelCount | Anexa à resposta a quantidade todal de modelos que a
marca requerida possui. |
parameters:
- name: Authorization
in: header
required: true
schema:
type: string
- name: include
in: query
required: false
schema:
type: string
example: models,modelsCount
responses:
'200':
description: Show Brand Response
content:
application/json:
example:
id: 2
name: Apple
models_count: 43
models:
- id: 9
name: iPhone 5s 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/9
- id: 10
name: iPhone 6s 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/10
- id: 11
name: iPhone 6s 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/11
- id: 12
name: iPhone 6s 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/12
- id: 13
name: iPhone 6s 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/13
- id: 14
name: iPhone 6s Plus 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/14
- id: 15
name: iPhone 6s Plus 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/15
- id: 16
name: iPhone 6s Plus 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/16
- id: 17
name: Iphone SE 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/17
- id: 18
name: Iphone SE 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/18
- id: 19
name: iPhone 7 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/19
- id: 20
name: iPhone 7 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/20
- id: 21
name: iPhone 7 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/21
- id: 22
name: iPhone 7 PLUS 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/22
- id: 23
name: iPhone 7 PLUS 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/23
- id: 24
name: iPhone 7 PLUS 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/24
- id: 25
name: iPhone 7 128GB RED
meta:
link: https://homolog.clubfix.com.br/webservice/models/25
- id: 26
name: iPhone 7 256GB RED
meta:
link: https://homolog.clubfix.com.br/webservice/models/26
- id: 27
name: iPhone 7 PLUS 128GB RED
meta:
link: https://homolog.clubfix.com.br/webservice/models/27
- id: 28
name: 'IPHONE 8 64GB '
meta:
link: https://homolog.clubfix.com.br/webservice/models/28
- id: 29
name: IPHONE 8 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/29
- id: 30
name: IPHONE 8 PL 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/30
- id: 31
name: IPHONE 8 PL 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/31
- id: 32
name: iPhone 5s 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/32
- id: 33
name: iPhone 5s 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/33
- id: 34
name: iPhone 5s 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/34
- id: 35
name: iPhone SE 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/35
- id: 36
name: iPhone SE 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/36
- id: 37
name: iPhone 6 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/37
- id: 38
name: iPhone 6 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/38
- id: 39
name: iPhone 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/39
- id: 40
name: iPhone 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/40
- id: 41
name: iPhone 6s 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/41
- id: 42
name: iPhone 6s 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/42
- id: 43
name: iPhone 6s 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/43
- id: 44
name: iPhone 6s 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/44
- id: 45
name: iPhone 6s Plus 16GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/45
- id: 46
name: 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/46
- id: 47
name: 64GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/47
- id: 48
name: 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/48
- id: 49
name: iPhone 7 32GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/49
- id: 50
name: iPhone 7 128GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/50
- id: 51
name: iPhone 7 256GB
meta:
link: https://homolog.clubfix.com.br/webservice/models/51
meta:
link: https://homolog.clubfix.com.br/webservice/brands/2
schema:
type: object
properties:
id:
type: integer
name:
type: string
models_count:
type: integer
models:
type: array
items:
type: object
properties:
id:
type: integer
name:
type: string
meta:
type: object
properties:
link:
type: string
meta:
type: object
properties:
link:
type: string
````