CMS - GetLandingPage


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

Payload de entrada:

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

Exemplo de request:

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

Responses:

200 OK

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