API de controle de gráficos

Esta API fornece a capacidade de controlar as transições de overlays 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


Amostra de solicitação

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


Resposta de amostra

{
  "id": "5f651ecb600cdfec4d4b0148",
  "name": "Late Night News Graphics",
  "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
id Identificador Gráfico Único string
name Nome gráfico string
controlUrl URL de controle do gráfico string 
editorUrl URL do editor de gráficos string
outputUrl URL de saída de gráficos string
experienceId Identificador único de Experience número
updateAvailable 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


Amostra de solicitação

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


Respostas de amostra

[
   {
      "id":"n29",
      "name":"News",
      "state":"in",
      "region":{
         "id":"n3",
         "name":"Center",
         "scene":{
            "id":"s1",
            "name":"Scene s1",
            "state":"out"
         }
      }
   },
   {
      "id":"n11",
      "name":"Timer",
      "state":"in",
      "region":{
         "id":"n4",
         "name":"Lower Third",
         "scene":{
            "id":"s1",
            "name":"Scene s1",
            "state":"out"
         }
      }
   },
   {
      "id":"n7",
      "name":"Last news title",
      "state":"out",
      "region":{
         "id":"n4",
         "name":"Lower Third",
         "scene":{
            "id":"s1",
            "name":"Scene s1",
            "state":"out"
         }
      }
   }
]


Campos de resposta

Chave Descrição Tipo
id Identificador de nó exclusivo string
name Nome do nó string
state 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


Amostra de solicitação

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 overlay 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


Amostra de solicitação em Windows

curl -H "Content-Type: application/json" -X PUT -d "["{\"id\":\"n9\",\"transition\":\"out\"}"]" https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/transition


Amostra de solicitação em Linux

curl -H "Content-Type: application/json" -X PUT -d '[{\"id\":\"n29\",\"transition\":\"out\"}]' https://api.flowics.com/graphics/YOUR-GRAPHICS-TOKEN/control/overlays/transition


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:

{
  "code": 1404,
  "flags": 404,
  "defaultMessage": "Graphics Token was not found.",
}


Campos de resposta de erro

Chave Descrição Tipo
code Identificador de erro único número
flags Código de status HTTP número
defaultMessage Descrição do erro string


Was this article helpful?