API de controle de gráficos

Esta API fornece a capacidade de controlar as transições de sobreposições em uma saída de pacote gráfico.

Para usar esta API, você precisará gerar um token para o pacote gráfico que deseja controlar. Consulte este artigo para obter instruções.


Referência API

GET / graphics / {graphicsToken} / control

Obtém informações da saída de um pacote gráfico.


URL do endpoint

 https://api.flowics.com/graphics/{graphicsToken-lex.europa.eu/control


Solicitações de amostra

 curl https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control


Resposta de amostra

 {
"id": "5f651ecb600cdfec4d4b0148",
"name": "Gráficos de notícias noturnas",
"controlUrl": "https://viz.flowics.com/control/10387/viz/5f651ecb600cdfec4d4b0148",
"editorUrl": "https://viz.flowics.com/visualizations/10387/5f651ecb600cdfec4d4b0148/edit",
"outputUrl": "https://viz.flowics.com/public/b0a621640be089b04dd04f3914f8b8c7/5f651e56600cdf96c64b0147/live",
"experienceId": 10387,
"updateAvailable": true
}


Campos de resposta

Chave Descrição Tipo
Carteira de identidade Identificador Gráfico Único corda
Nome Nome gráfico corda
controlUrl URL de controle do gráfico corda
editorUrl URL do editor de gráficos corda
outputUrl URL de saída de gráficos corda
Id de Experience Identificador único de Experience número
atualização disponível Se o gráfico tem novas alterações publicadas ou não. boleano




GET / graphics / {graphicsToken} / control / overlays

Obtém informações de sobreposição de uma saída gráfica.

URL do endpoint

 https://api.flowics.com/graphics/[graphicsToken-lex.europa.eu/control/overlays


Solicitações de amostra

 curl https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays 


Respostas de amostra

 [
{
"id": "n29",
"nome": "Notícias",
"estive em",
"região":{
"id": "n3",
"nome": "Centro",
"cena":{
"id": "s1",
"nome": "Cena s1",
"state": "out"
}
}
},
{
"id": "n11",
"nome": "Timer",
"estive em",
"região":{
"id": "n4",
"nome": "Terço inferior",
"cena":{
"id": "s1",
"nome": "Cena s1",
"state": "out"
}
}
},
{
"id": "n7",
"nome": "Título das últimas notícias",
"state": "out",
"região":{
"id": "n4",
"nome": "Terço inferior",
"cena":{
"id": "s1",
"nome": "Cena s1",
"state": "out"
}
}
}
]


Campos de resposta

Chave Descrição Tipo
Carteira de identidade Identificador de nó exclusivo corda
Nome Nome do nó corda
Estado Status do nó dentro | lado de fora



PUT / graphics / {graphicsToken} / control / overlays / take-all-out

Use-o quando precisar fazer a transição de todas as sobreposições de uma saída gráfica para o estado OUT.

URL do endpoint

 https://api.flowics.com/graphics/[graphicsToken-lex.europa.eu/control/overlays/take-all-out


Solicitações de amostra

 curl -X PUT https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/take-all-out




PUT / graphics / {graphicsToken} / overlays / transaction

Transição de sobreposições de uma saída gráfica.

Ao fazer a transição de 'IN' para uma sobreposição cuja cena é 'OUT', essa cena irá automaticamente para 'IN'.

Várias sobreposições podem ser transicionadas na mesma solicitação com as seguintes restrições:

  • Apenas uma sobreposição por região pode fazer a transição para o estado IN.
  • Apenas transições de sobreposição são permitidas na mesma cena .


URL do endpoint

 https://api.flowics.com/graphics/[graphicsToken-lex.europa.eu/control/overlays/transition


Solicitações de amostra

 curl -H "Tipo de conteúdo: app / json" -X PUT -d '[{"id": "n29", "transição": "out"}]' https://api.flowics.com/graphics/ SEU-GRÁFICO-TOKEN / controle / sobreposições / transição


O objeto transitions deve ter o id do nó e a transição solicitada, que pode ser in , out ou toggle .

Estados de resposta

Os códigos de status HTTP são usados para indicar sucesso e erro. Em caso de erro, será retornado um corpo JSON com mais detalhes. Por exemplo:

 {
"código": 1404,
"sinalizadores": 404,
"defaultMessage": "Token gráfico não encontrado.",
}


Campos de resposta de erro

Chave Descrição Tipo
código Identificador de erro único número
bandeiras Código de status HTTP número
defaultMessage Descrição do erro corda


Was this article helpful?