APIs - Tutoriais

GetWidget

30 views 18/08/2021 18/08/2021 rodolfo-andrade 0

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

Payload de entrada:

{
  "widgetId": "string"  // Identificador do widget. Deve seguir o formato widget://<tenant-domain>/<domain>/<service>/<name>
}

Exemplo de request:

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

Responses:

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

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"
}

Este artigo foi útil para você?