Campos de configurações
Referência de todas as propriedades de um objeto de configuração: nomes, descrições e valores aceitos, incluindo as letras de tipo.
Uma configuração na API tem várias propriedades, representadas por campos. Esta página lista todos os campos aceitos, com as descrições e os tipos de dado.
Campos de configurações
A tabela a seguir lista todos os campos disponíveis nos objetos de configuração:
| Nome do campo | Descrição | Valores aceitos |
|---|---|---|
name* | Nome da configuração | string |
description | Descrição da configuração | string |
object_id | ID da configuração | integer |
section_id | ID da seção pai | ID de seção válido |
section_tab_id | ID da aba pai | ID de aba válido |
value | Valor da configuração | Depende do tipo da configuração |
edition_type | Tipo de edição | PRO:ROOT, ULT:ROOT, ULT:VENDOR, MVE:ROOT, MVE:VENDOR, ROOT, VENDOR |
handler | Nome da função PHP que gera as variantes da configuração | string |
is_global | Indicador que define se a configuração é global | Y, N |
object_type | Tipo da configuração | nenhum |
position | Posição da configuração na lista de configurações | integer |
section_name | Nome da seção pai | nenhum |
section_tab_name | Nome da aba pai | nenhum |
tooltip | Dica de ajuda (tooltip) | string |
type* | Tipo da configuração | Veja as letras de tipo abaixo |
variants | Variantes da configuração | Lista dos valores possíveis da configuração |
Letras de tipo da configuração
O campo type recebe uma destas letras:
| Letra | Tipo |
|---|---|
I | campo de texto (input) |
T | área de texto (textarea) |
R | grupo de opções (radiogroup) |
S | lista de seleção (selectbox) |
P | senha |
C | caixa de seleção (checkbox) |
M | seleção múltipla |
N | várias caixas de seleção |
X | lista de países |
W | lista de estados |
F | arquivo |
O | informação |
H | cabeçalho |
B | caixa selecionável |
E | template |
Z | template permanente |
D | oculto |
Exemplo de requisição de configuração
json
{
"name": "items_per_page",
"description": "Number of items to display per page",
"type": "I",
"value": "20",
"section_id": 15,
"position": 30,
"tooltip": "Controls the number of items shown on catalog and search pages",
"is_global": "Y"
}Endpoints da API para configurações
| Método | Caminho | Descrição |
|---|---|---|
| GET | /settings | Recupera a lista de todas as configurações. |
| GET | /settings/{id} | Recupera uma configuração pelo ID. |
| PUT | /settings/{id} | Atualiza uma configuração com as informações enviadas. |
Os exemplos completos de requisição e resposta estão em Endpoints.