Endpoints de configurações
As URLs da API de configurações: a lista de configurações e uma configuração individual (consultar e atualizar), com os códigos de resposta.
A API de configurações permite consultar e modificar as configurações do sistema. Os endpoints dão acesso a parâmetros globais de configuração e a preferências por usuário. Todos usam credenciais HTTP Basic ($EMAIL:$API_KEY) e o endereço base da loja ($BASE_URL/api).
A coleção de configurações
O caminho /api/settings recupera a lista de todas as configurações disponíveis do sistema.
| Método | Descrição |
|---|---|
| GET | Recuperar todas as configurações |
Listar configurações
/api/settingsAdminRecupera todas as configurações
Parâmetros de consulta
pageintegerpadrão: 1Página da lista, veja Paginação.
items_per_pageintegerpadrão: 10Quantidade de configurações por página.
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings"200Exemplo de resposta
json
{
"data": [
{
"id": "timezone",
"name": "System Timezone",
"value": "America/Sao_Paulo",
"description": "Default timezone for date and time operations",
"modifiable": true
},
{
"id": "currency",
"name": "Default Currency",
"value": "BRL",
"description": "Currency used for monetary values",
"modifiable": true
}
],
"meta": {
"total": 24,
"page": 1,
"per_page": 10
}
}Uma configuração
O caminho /api/settings/{id} recupera ou atualiza uma configuração pelo ID.
Parâmetros de caminho
idstringobrigatórioO identificador único da configuração.
| Método | Descrição |
|---|---|
| GET | Recuperar uma configuração |
| PUT | Atualizar uma configuração |
Consultar uma configuração
/api/settings/{id}AdminRecupera uma configuração
Parâmetros de caminho
idstringobrigatórioO identificador único da configuração.
bash
curl -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/email_sender"200Exemplo de resposta do GET
json
{
"id": "email_sender",
"name": "Email Sender Address",
"value": "no-reply@venddor.com.br",
"description": "Default email address used for sending system notifications",
"modifiable": true,
"validation": "email",
"last_modified": "2025-03-12T14:22:18Z",
"modified_by": "admin"
}Atualizar uma configuração
/api/settings/{id}AdminAtualiza uma configuração
Parâmetros de caminho
idstringobrigatórioO identificador único da configuração.
Corpo da requisição
valuestringobrigatórioO novo valor da configuração.
bash
curl -X PUT -u "$EMAIL:$API_KEY" "$BASE_URL/api/settings/email_sender" \
-H "Content-Type: application/json" \
-d '{
"value": "support@venddor.com.br"
}'Códigos de status da resposta
| Código de status | Descrição |
|---|---|
200 OK | Configuração recuperada ou atualizada com sucesso |
400 Bad Request | Parâmetros da requisição inválidos ou erro de validação |
403 Forbidden | Permissões insuficientes para modificar a configuração |
404 Not Found | A configuração com o ID informado não existe |