CMS - GetWidget

  • Fri, 09/03/2021 - 10:16
  • /giovani.lisboa@...

Exibe as informações do widget buscando através do seu identificador.

Payload de entrada:

{ // Identificador do widget. Deve seguir o formato widget:///// "widgetId": "string" }

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms​/getWidget" --header "Authorization: Bearer {access_token}" --header "client_id: {client_id}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "widgetId": "string" }"

Responses:

200 OK

{ // Identificador URI desse widget. Deve seguir o formato widget:///// "id": "string", // A chave de internacionalização do nome desse widget. Chave associada ao bundle do platform.cms "name": "string", // A chave de internacionalização da descrição desse widget. Chave associada ao bundle do platform.cms "description": "string", // O recurso necessário para acessar esse widget "permission": { // O URI do resource "resource": "string", // O nome da ação "action": "string" }, // A URL onde esse widget se encontra "url": "string", // A URL onde pode ser obtido o thumbnail desse widget "thumbnailURL": "string", // As tags associadas a esse widget "tags": [ "string" ], // O tamanho preferido para melhor visualização "preferredSize": { // Altura, quando utilizada em uma página com valores absolutos, cada unidade representará 40 pixels "height": 0, // Largura "width": 0 } }

400 Bad Request - Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente

{ "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "BAD_REQUEST", "domain": "platform", "service": "cms" }

401 Unauthorized - Usuário ou senha inválido

{ "error_description": "Descrição do erro", "error": "codigo_do_erro" }

403 Forbidden - Permissão negada

404 Not Found - Componente não encontrado

{ "message": "Descrição do erro", "errorCode": "codigoDoErro", "reason": "OBJECT_NOT_FOUND", "domain": "platform", "service": "cms" }