Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.


...

O WCMSpaceAPI é um facilitador para a utilização de algumas API's disponíveis no TOTVS Fluig. A lista abaixo detalha algumas dessas API's.

Painel
borderColor#f2f2f2
bgColor#f2f2f2

É recomendado utilizar a Função ao invés da API, pois a função abstrai a passagem de alguns parâmetros, que seria necessário inserir manualmente no consumo da API.

para gerenciar as informações da URL de Dashboard do Fluig Analytics.

Lembrando que uma página pode possuir uma ou mais  instâncias de Widget de Analytics.


API consumidaEspecificação

{FLUIG_URL}/portal/api/rest/wcm/iframe/analytics/url/{instanceId}

onde instanceId, é o id da instância da widget de Analytics na página

FunçãoEspecificaçãoAPI consumidaWCMSpaceAPI.IframeAnalyticsRest.GETURL

Retorna a URL para renderizar o iframe da Dashboard do Fluig Analytics:

  • A URL já retorna com o redirecionamento para o Identity, onde ocorrerá a validação, e também o parâmetro RelayState que indica o redirecionamento para o Fluig Analytics.

{FLUIG_URL}/portal/api/rest/wcm/iframe/analytics/

url

save/{instanceId}

onde instanceId, é o id da instância da widget de Analytics na página

WCMSpaceAPI.IframeAnalyticsRest.UPDATEPREFERENCESANALYTICS

Atualiza a URL para renderizar o iframe da Dashboard do Fluig Analytics:

  • Essa API deve ser utilizada para atualizar a URL, caso ocorra uma alteração no id do projeto ou no id da Dashboard no Fluig Analytics.

{FLUIG_URL}/portal/api/rest/wcm/iframe/analytics/save/{instanceId}

onde instanceId, é o id da instância da widget de Analytics na página