APIs - Tutoriais

GetLandingPage

21 views 18/08/2021 rodolfo-andrade 0

Permite buscar as informações de uma landing page com as informações da página vinculada.

Payload de entrada:

{
  "landingPageId": "string"  // Identificador da landing page
}

Exemplo de request:

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

Responses:

200 OK
{
  "landingPage": {                 // Informações completas da landing page com a página
    "id": "string",                // Identificador da landing page no formato landing://{domínio do tenant}/{identificador único da página}
    "page": {                      // Informações completas de uma página e todos seus componentes
      "id": "string",              // Identificador da página no padrão page://{domínio do tenant}/{identificador único da página}
      "name": "string",            // Nome da página
      "credentials": true,         // Indica se devem ser enviadas as credenciais para os componentes da página
      "includeToolbar": true,      // Indica se devem ser exibido a barra de ferramentas na página ou não
      "positionType": "ABSOLUTE",  // Indica se os componentes possuirão tamanhos absolutos (fixos) ou relativos à tela (Tipos padrões: ABSOLUTE e RELATIVE)
      "components": [              // Componentes da página
        {
          "height": 0,             // Altura
          "width": 0,              // Largura
          "position": {            // Posição onde inicia a exibição do componente
            "row": 0,              // Linha
            "column": 0            // Coluna
          }
        }
      ]
    },
    "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
    "roles": [                     // Papéis da landing page se for compartilhada
      "string"
    ]
  }
}
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)

404 Not Found (Página não encontrada)
{
  "message": "Descrição do erro",
  "errorCode": "codigoDoErro",
  "reason": "OBJECT_NOT_FOUND",
  "domain": "platform",
  "service": "cms"
}

Este artigo foi útil para você?