Exibir código-fonte para API externa de comunicação

==Estrutura==
A API do sistema foi criada para comunicar-se com diversas outras APIs de forma padronizada. Para isso, alguns padrões para a criação dessas outras APIs devem ser seguidos.

São carregadas diversas webparts, que são estruturas que contém os gráficos. Cada gráfico é uma requisição à API de um serviço, pré-cadastrados no cadastro de serviços.

'''Tipo de indicadores suportados:'''
*Gráfico
**Barra
**Coluna
**Área
**Areaspline
**Pontos
**Linha
**Pizza
*Texto

Para que seja exibido o indicador, deve-se seguir o formato JSON pré-definido:

<syntaxhighlight lang="json" line="1" >
{
	"data": [],
        "filter": [],
        "period": []
}
</syntaxhighlight>

'''Data(<span style="color: red">obrigatório</span>):''' O formato varia de acordo com o indicador.

'''Filter:''' Não é obrigatório e o formato não varia.

'''Period:''' Não é obrigatório e o formato não varia.

==Indicador do tipo gráfico==

Nos indicadores do tipo gráfico, podemos identificar categorias e séries conforme figura abaixo:

[[Arquivo:IndicadorTipoGrafico.jpg | 800px]]

A figura acima representa a interpretação do Highcharts em relação aos dados que são trazidos de uma API. 

Para os gráficos do tipo Barra, Coluna, Área, Areaspline, Pontos ou Linha, espera a seguinte estrutura:

<syntaxhighlight lang="json" line="1" >
{
	"data": [{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "1",
		"name": "01°CRE",
		"series": {
			"Berçário": "5",
			"Maternal I": "5",
			"Maternal II": "5"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "2",
		"name": "02°CRE",
		"series": {
			"Berçário": "3",
			"Maternal I": "3",
			"Maternal II": "3"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "3",
		"name": "03°CRE",
		"series": {
			"Berçário": "4",
			"Maternal I": "4",
			"Maternal II": "4"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "4",
		"name": "04°CRE",
		"series": {
			"Berçário": "7",
			"Maternal I": "7",
			"Maternal II": "7"
		}
	}]
}
</syntaxhighlight>

Para o gráfico de pizza, segue o exemplo:
<syntaxhighlight lang="json" line="1" >
{
	"data": [{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "1",
		"name": "Eficincia de válvulas",
		"series": {
			"V1":"7.0",
			"V2":"6.9",
			"V3":"9.5",
			"V4":"14.5",
			"V5":"18.2",	
			"V6":"21.5"
		}
	}]
}
</syntaxhighlight>

Conforme exemplo citado acima, é esperado um objeto “data”. Dentro deste objeto, é necessário um atributo “Id” e um dataName, que representarão um ID (não exibido no gráfico) e o NOME, que é exibido na categoria do gráfico (Ex: Vagas, Inscrições, Aloc, etc).

Este id é utilizado como parâmetro de filtro no momento em que é clicado em uma categoria, para realizar o drilldown e exibir um próximo gráfico filtrado por esta categoria.

Há também um objeto “series” dentro de “data”. Nele é possível identificar um padrão “chave”:“valor”, em que “chave” será apresentado no gráfico com o nome da série (Ex: Berçário, Maternal I, Maternal II, etc) e o “valor” é expressado como quantidade da série (Ex: 71,5; 78,8; etc).

==Indicador do tipo texto==

Há também a possibilidade da criação de indicadores textuais, com o objetivo de fornecer uma informação escrita ao usuário.

Abaixo segue um exemplo de Json para este tipo de indicador:

<syntaxhighlight lang="json" line="1" >
{
	"data": [{
		"entity": "6cf424dc-8ec3-e011-9b36-00155d033206",
		"id": "1",
		"text": "Ciclo Autoral <br/>170.719"
		}]
}
</syntaxhighlight>

A informação que será exibida pelo indicador será especificada na “chave” text.

Nesta chave existe a possibilidade de acrescentar tags html; geralmente se este tipo de indicador for usado em um painel com layout customizado.

Geralmente as tags mais usadas são para a quebra de linhas e formatação da fonte (tamanho, negrito, itálico, sublinhado, etc).

==Filtros==

O campo “filter” dá a possibilidade de adicionar filtros dos quais podem ser utilizados nos indicadores. É necessário que o recurso do serviço esteja preparada para receber esse filtro. Ex: ''http://siteapi.com.br/API/NomeRecurso?anoInicio=2016''

<syntaxhighlight lang="json" line="1" >
{
	"filter": [{
		"id": "AnoInicio",
		"nameJson": "anoInicio",
		"values": [
			“2015”,
			“2016”,
			“2017”
			]
		}]
}
</syntaxhighlight>

==Data de processamento==

O campo “period” é a data de processamento dos gráficos. Esse processamento pode ser feito em somente 1 dia ou em vários dias.

Essas datas deverão ser enviadas no formato de string ou em caso de processamento em mais de 1 dia, deverá ser enviado uma lista de strings. 

No sistema será mostrado a data de processamento do gráfico, em caso de processamento em mais de 1 dia será mostrada a data mais atual.

<syntaxhighlight lang="json" line="1" >
{
	"period": [“31/12/2014”]
}

{
	"period": [
		“31/12/2014”,
		“31/12/2015”,
		“31/12/2016”
		]
}
</syntaxhighlight>

[[Arquivo:IndicadorDataProcessamento.jpg]]

==Exemplo Completo==

<syntaxhighlight lang="json" line="1" >
{
	"period": [
		“31/12/2014”,
		“31/12/2015”,
		“31/12/2016”
		],
	"data": [{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "1",
		"name": "01°CRE",
		"series": {
			"Berçário": "5",
			"Maternal I": "5",
			"Maternal II": "5"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "2",
		"name": "02°CRE",
		"series": {
			"Berçário": "3",
			"Maternal I": "3",
			"Maternal II": "3"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "3",
		"name": "03°CRE",
		"series": {
			"Berçário": "4",
			"Maternal I": "4",
			"Maternal II": "4"
		}
	},
	{
		"entity": "833061aa-0b6d-e111-a12a-000c29820a8b",
		"id": "4",
		"name": "04°CRE",
		"series": {
			"Berçário": "7",
			"Maternal I": "7",
			"Maternal II": "7"
		}
	}],
	"filter": [{
		"id": "AnoInicio",
		"nameJson": "anoInicio",
		"values": [
			“2015”,
			“2016”,
			“2017”
			]
		}]
}
</syntaxhighlight>

== Página Inicial ==

[[InfoCenter]]