Configurações

Consulte e altere as configurações gerais da loja, como o nome da empresa, o e-mail do administrador e a moeda padrão.

A API de configurações permite gerenciar as configurações gerais do sistema pela API. Você pode consultar, atualizar e administrar as configurações que afetam o comportamento da loja.

Recorra a ela quando precisar ler um valor de configuração a partir de outro sistema ou alterá-lo sem abrir o painel. As rotas ficam em $BASE_URL/api/settings, exigem uma conta de administrador e usam credenciais HTTP Basic ($EMAIL:$API_KEY).

Como funciona

Primeiro você lista as configurações (ou lê uma pelo nome) para ver o valor atual. Depois envia o novo value para a mesma configuração. Teste cada alteração em um ambiente de desenvolvimento antes de repeti-la em produção, porque uma configuração pode mudar o comportamento da loja inteira.

Conceitos principais

Configurações comuns

Estas são algumas configurações muito usadas que podem ser gerenciadas pela API:

Nome da configuração	Descrição	Tipo
`company_name`	Nome da loja ou da empresa	String
`site_admin_email`	Endereço de e-mail do administrador	String
`default_currency`	Código da moeda padrão	String
`enable_inventory_tracking`	Ativa ou desativa o controle de estoque	Booleano (Y/N)
`mailer_send_method`	Método de envio de e-mail	String

Endpoints

Método	Caminho	Finalidade	Autenticação
GET	`/api/settings`	Recupera a lista de todas as configurações disponíveis do sistema, veja abaixo	Admin
GET	`/api/settings/{id}`	Recupera uma configuração pelo nome, veja abaixo	Admin
PUT	`/api/settings/{setting_name}`	Atualiza o valor de uma configuração, veja abaixo	Admin

Listar configurações

GET/api/settingsAdmin

Recupera a lista de todas as configurações disponíveis do sistema

Esta rota aceita filtros e paginação para ajudar você a encontrar configurações específicas (veja Paginação).

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/"

Consultar uma configuração

GET/api/settings/{id}Admin

Recupera uma configuração pelo nome

Parâmetros de caminho

idstringobrigatório

O nome da configuração, por exemplo company_name.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/company_name"

Atualizar uma configuração

PUT/api/settings/{setting_name}Admin

Atualiza o valor de uma configuração

Parâmetros de caminho

setting_namestringobrigatório

O nome da configuração a atualizar, por exemplo company_name.

Corpo da requisição

valuestringobrigatório

O novo valor da configuração.

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/company_name" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "Venddor Store"
}'

Erros comuns

Alterar uma configuração em produção sem testar a mudança antes em um ambiente de desenvolvimento.
Usar uma chave de API sem as permissões certas: algumas configurações exigem privilégios de administrador.
Enviar o valor de uma configuração de sim ou não, como enable_inventory_tracking, como booleano. A tabela de configurações comuns a descreve como Booleano (Y/N).

Próximos passos

Endpoints

As URLs /api/settings, o objeto de configuração e os códigos de resposta.

Paginação

Percorra as configurações em páginas.

Campos

Todas as propriedades de uma configuração.

API legada/Referência completa

Configurações

Consulte e altere as configurações gerais da loja, como o nome da empresa, o e-mail do administrador e a moeda padrão.

A API de configurações permite gerenciar as configurações gerais do sistema pela API. Você pode consultar, atualizar e administrar as configurações que afetam o comportamento da loja.

Nome da configuração	Descrição	Tipo
`company_name`	Nome da loja ou da empresa	String
`site_admin_email`	Endereço de e-mail do administrador	String
`default_currency`	Código da moeda padrão	String
`enable_inventory_tracking`	Ativa ou desativa o controle de estoque	Booleano (Y/N)
`mailer_send_method`	Método de envio de e-mail	String

Endpoints

Método	Caminho	Finalidade	Autenticação
GET	`/api/settings`	Recupera a lista de todas as configurações disponíveis do sistema, veja abaixo	Admin
GET	`/api/settings/{id}`	Recupera uma configuração pelo nome, veja abaixo	Admin
PUT	`/api/settings/{setting_name}`	Atualiza o valor de uma configuração, veja abaixo	Admin

Listar configurações

GET/api/settingsAdmin

Recupera a lista de todas as configurações disponíveis do sistema

Esta rota aceita filtros e paginação para ajudar você a encontrar configurações específicas (veja Paginação).

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/"

Consultar uma configuração

GET/api/settings/{id}Admin

Recupera uma configuração pelo nome

Parâmetros de caminho

idstringobrigatório

O nome da configuração, por exemplo company_name.

bash

curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/company_name"

Atualizar uma configuração

PUT/api/settings/{setting_name}Admin

Atualiza o valor de uma configuração

Parâmetros de caminho

setting_namestringobrigatório

O nome da configuração a atualizar, por exemplo company_name.

Corpo da requisição

valuestringobrigatório

O novo valor da configuração.

bash

curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/company_name" \
  -H "Content-Type: application/json" \
  -d '{
  "value": "Venddor Store"
}'

Erros comuns

Alterar uma configuração em produção sem testar a mudança antes em um ambiente de desenvolvimento.
Usar uma chave de API sem as permissões certas: algumas configurações exigem privilégios de administrador.
Enviar o valor de uma configuração de sim ou não, como enable_inventory_tracking, como booleano. A tabela de configurações comuns a descreve como Booleano (Y/N).

Próximos passos

Endpoints

As URLs /api/settings, o objeto de configuração e os códigos de resposta.

Paginação

Percorra as configurações em páginas.

Campos

Todas as propriedades de uma configuração.