Ajustes do módulo

Lê e grava os ajustes próprios de um módulo instalado, como chaves de integração e opções.

Cada módulo tem seus ajustes (o ID de métrica do Google Analytics, a chave de um meio de pagamento, os textos de uma funcionalidade). Estas rotas usam o slug do módulo, não o id. Os campos aceitos estão no config_schema do módulo, em Catálogo de módulos. A gravação é um merge: só as chaves enviadas mudam.

Ler ajustes

GET/api/v1/admin/modules/{moduleSlug}/settingsAdmin

Ler os ajustes de um módulo

Parâmetros de caminho

moduleSlugstringobrigatório

Slug do módulo, como google-analytics.

Exemplo de requisição (ler)

Resposta (ler)

200Ajustes

Campos da resposta

module_slugstring

O módulo.

settingsobject

Exatamente o que a loja gravou. As chaves dependem do módulo; campos do tipo senha vêm em texto: trate a resposta como sensível.

effective_settingsobject

Só em whatsapp-commerce: os ajustes já com os valores herdados da plataforma.

inheritedobject

Só em whatsapp-commerce: quais chaves vêm da plataforma ("business_account_id": true).

cloud_apiobject

Só em whatsapp-commerce: descrição da conexão herdada.

Erros (ler)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_modules` nem `manage_settings` (basta um dos dois).	`{"error":"insufficient privileges","privilege_required_any":["manage_modules","manage_settings"]}`
404	O módulo não está instalado na loja, ou o slug não existe.	`{"error":"module not installed or no settings","detail":"module not installed"}`

Gravar ajustes

PUT/api/v1/admin/modules/{moduleSlug}/settingsAdmin

Gravar os ajustes de um módulo

Parâmetros de caminho

moduleSlugstringobrigatório

Slug do módulo, como google-analytics.

Corpo da requisição

settingsobjectobrigatório

Chaves a gravar. Uma chave ausente fica como está; uma chave com valor null é removida.

Exemplo de requisição (gravar)

Resposta (gravar)

200Ajustes gravados

Campos da resposta

module_slugstring

O módulo.

settingsobject

Os ajustes completos depois da gravação.

Erros (gravar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_modules` nem `manage_settings` (basta um dos dois).	`{"error":"insufficient privileges","privilege_required_any":["manage_modules","manage_settings"]}`
400	Corpo que não é JSON válido.	`{"error":"invalid request body","detail":"..."}`
400	`whatsapp-commerce`: campo obrigatório em branco ou formato inválido. O corpo traz `code` e `field`.	`{"error":"...","code":"...","field":"phone_number_id"}`
404	O módulo não está instalado na loja.	`{"error":"failed to update module settings","detail":"..."}`

Veja também

Ajustes do módulo

Lê e grava os ajustes próprios de um módulo instalado, como chaves de integração e opções.

Ler ajustes

GET/api/v1/admin/modules/{moduleSlug}/settingsAdmin

Ler os ajustes de um módulo

Parâmetros de caminho

moduleSlugstringobrigatório

Slug do módulo, como google-analytics.

Exemplo de requisição (ler)

Resposta (ler)

200Ajustes

Campos da resposta

module_slugstring

O módulo.

settingsobject

Exatamente o que a loja gravou. As chaves dependem do módulo; campos do tipo senha vêm em texto: trate a resposta como sensível.

effective_settingsobject

Só em whatsapp-commerce: os ajustes já com os valores herdados da plataforma.

inheritedobject

Só em whatsapp-commerce: quais chaves vêm da plataforma ("business_account_id": true).

cloud_apiobject

Só em whatsapp-commerce: descrição da conexão herdada.

Erros (ler)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_modules` nem `manage_settings` (basta um dos dois).	`{"error":"insufficient privileges","privilege_required_any":["manage_modules","manage_settings"]}`
404	O módulo não está instalado na loja, ou o slug não existe.	`{"error":"module not installed or no settings","detail":"module not installed"}`

Gravar ajustes

PUT/api/v1/admin/modules/{moduleSlug}/settingsAdmin

Gravar os ajustes de um módulo

Parâmetros de caminho

moduleSlugstringobrigatório

Slug do módulo, como google-analytics.

Corpo da requisição

settingsobjectobrigatório

Chaves a gravar. Uma chave ausente fica como está; uma chave com valor null é removida.

Exemplo de requisição (gravar)

Resposta (gravar)

200Ajustes gravados

Campos da resposta

module_slugstring

O módulo.

settingsobject

Os ajustes completos depois da gravação.

Erros (gravar)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem `manage_modules` nem `manage_settings` (basta um dos dois).	`{"error":"insufficient privileges","privilege_required_any":["manage_modules","manage_settings"]}`
400	Corpo que não é JSON válido.	`{"error":"invalid request body","detail":"..."}`
400	`whatsapp-commerce`: campo obrigatório em branco ou formato inválido. O corpo traz `code` e `field`.	`{"error":"...","code":"...","field":"phone_number_id"}`
404	O módulo não está instalado na loja.	`{"error":"failed to update module settings","detail":"..."}`