APIs - Tutoriais

SaveLandingPage

20 views 18/08/2021 rodolfo-andrade 0

Permite adicionar uma página à landing page. Para vincular a página, será necessário ter permissão de visualização para a mesma. Se possuir somente a ação Personalizar, então só poderá criar páginas do tipo PERSONAL.

Payload de entrada:

{
  "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
  "roles": [                     // Papéis da landing page se for compartilhada, se omitido, não realiza alterações
    "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”

Exemplo de request:

curl --location --request POST "https://api.senior.com.br/platform/cms​/actions​/saveLandingPage" --header "Authorization: Bearer {access_token}" --header "Content-Type: application/json" --header "Accept: application/json" --data-raw "{ "id": "string", "pageId": "string", "title": "string", "includeHeader": true, "landingPageType": "DEFAULT", "roles": [ "string" ] } "

Responses:

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

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ê?