APIs - Tutoriais

GetUserLandingPages

17 views 18/08/2021 rodolfo-andrade 0

Lista as landing pages para visualização pelo usuário.

Payload de entrada:

{}

Exemplo de request:

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

Responses:

200 OK
{
  "landingPages": {               // Retorna as informações das landing pages
    "id": "string",               // Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página}
    "pageId": "string",           // Identificador da página
    "title": "string",            // Título da página
    "includeHeader": true,        // Se inclui o header da página com o título
    "landingPageType": "DEFAULT"  // Tipo da landing page
  }
}
Tipos de landing page padrões:

    DEFAULT – “Indica que é uma landing page padrão para caso o usuário não tenha nenhuma landing page compartilhada configurada”
    SHARED – “Indica uma landing page compartilhada com papéis”
    PERSONAL – “Indica que é uma landing page pessoal, somente o usuário que criou conseguirá visualizar”

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)

Este artigo foi útil para você?