Documentação

Aqui começamos nossa documentação, vamos ter badges classificando o tipo de requisição e a rota pai como estas:

/rotaPai GET PUT POST

Nomenclatura de Campos

Todas os campos do JSON de resposta tem o mesmo nome dos campos do banco de dados, então, a nomeclatura dos campos de um GET não irão mudar em um PUT ou um POST. (Serão unilaterais).

Caso tenha dúvida de como implementar em sua linguagem vide o Inicio Rápido. Tudo Pronto? Vamos lá então!

Empresa

/company

getDepartments

/company GET

Requisição para obter os departamentos da empresa.

URL

https://api.grupoadvis.com.br/company/getDepartments

JavaScript

fetch("https://api.grupoadvis.com.br/company/getDepartments", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url https://api.grupoadvis.com.br/company/getDepartments \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 1668,
		"nome": "Produção",
		"area": 1
	},
	{
		"id": 1669,
		"nome": "Administrativo",
		"area": 0
	}
	]
}

Legenda

Campo	Valor	Significado
"area"	0	Área de Apoio
"area"	1	Área de Negócio

getBranches

/company GET

Requisição para obter as Filiais da empresa.

URL

https://api.grupoadvis.com.br/company/getBranches

JavaScript

fetch("https://api.grupoadvis.com.br/company/getBranches", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/company/getBranches' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 760,
		"nome": "Filial X",
		"estado": "Santa Catarina",
		"cidade": "Chapecó"
	},
	{
		"id": 761,
		"nome": "Filial Z",
		"estado": "Santa Catarina",
		"cidade": "Florianópolis"
	}
	]
}

getRoles

/company GET

Requisição para obter os Cargos da empresa.

URL

https://api.grupoadvis.com.br/company/getRoles

JavaScript

fetch("https://api.grupoadvis.com.br/company/getRoles", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url https://api.grupoadvis.com.br/company/getRoles \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 5552,
		"nome": "Supervisor",
		"descricao": "Lorem Ipsum Sit Dolor Amet"
	},
	{
		"id": 5608,
		"nome": "Data Scientist",
		"descricao": "Lorem Ipsum Sit Dolor Amet"
	},
	{
		"id": 5609,
		"nome": "Software Engineer",
		"descricao": "Lorem Ipsum Sit Dolor Amet"
	}
	]
}

getFunctionsByRole

/company GET

Requisição para obter as Funções de um determinado Cargo da empresa.

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do cargo que você pode obter na /company/getRoles)

URL

https://api.grupoadvis.com.br/company/getFunctionsByRole/ID

JavaScript

fetch("https://api.grupoadvis.com.br/company/getFunctionsByRole/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/company/getFunctionsByRole/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 2941,
		"nome": "Supervisor de Qualidade",
		"id_cargo": 5552,
		"descricao": "Lorem Ipsum Sit Dolor Amet"
	},
	{
		"id": 2981,
		"nome": "Supervisor de Produção",
		"id_cargo": 5552,
		"descricao": null
	},
	{
		"id": 2991,
		"nome": "Supervisor Segurança",
		"id_cargo": 5552,
		"descricao": "Lorem Ipsum Sit Dolor Amet"
	}
	]
}

insertDepartment

/company POST

Insere departamentos, os quais você obtem na /company/getDepartments

Campos Obrigatórios

Campo	Tipo
"nome"	String

URL

https://api.grupoadvis.com.br/company/insertDepartment

JavaScript

fetch("https://api.advistecnologia.com.br/company/insertDepartment", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome": "Departamento X",
		"area": 1
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request POST \
	--url https://api.advistecnologia.com.br/company/insertDepartment \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI' \
	--data '{
		"nome" : "Departamento X",
		"area" : 1
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 1909
	}
}

insertBranch

/company POST

Insere filiais, os quais você obtem na /company/getBranches

Campos Obrigatórios

Campo	Tipo
"nome"	String
"cidade"	String
"estado"	String

URL

https://api.grupoadvis.com.br/company/insertBranch

JavaScript

fetch("https://api.advistecnologia.com.br/company/insertBranch", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Filial X",
		"estado" : "Santa Catarina",
		"cidade" : "Chapecó"
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request POST \
	--url https://api.advistecnologia.com.br/company/insertBranch \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI' \
	--data '{
		"nome" : "Filial X",
		"estado" : "Santa Catarina",
		"cidade" : "Chapecó"
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 763
	}
}

insertRole

/company POST

Insere cargos, os quais você obtem na /company/getRoles

Campos Obrigatórios

Campo	Tipo
"nome"	String

URL

https://api.grupoadvis.com.br/company/insertRole

JavaScript

fetch("https://api.advistecnologia.com.br/company/insertRole", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Programador Master",
		"descricao" : "Lorem Ipsum Sit Dolor Amet"
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request POST \
	--url https://api.advistecnologia.com.br/company/insertRole \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI' \
	--data '{
		"nome" : "Programador Master",
		"descricao" : "Lorem Ipsum Sit Dolor Amet"
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 5975
	}
}

insertFunction

/company POST

Insere funções, as quais você obtem na /company/getFunctionsByRole

Campos Obrigatórios

Campo	Tipo
"nome"	String
"id_cargo"	Int

URL

https://api.grupoadvis.com.br/company/insertFunction

JavaScript

fetch("https://api.advistecnologia.com.br/company/insertFunction", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Analista de resultados III",
		"id_cargo" : 5601,
		"descricao" : "A função realiza análise de resultados na linha de produção"
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request POST \
	--url https://api.advistecnologia.com.br/company/insertFunction \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI' \
	--data '{
		"nome" : "Analista de resultados III",
		"id_cargo" : 5601,
		"descricao" : "A função realiza análise de resultados na linha de produção"
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 5975
	}
}

Funcionário

/employee

getEmployees

/employee GET

Requisição para obter os Colaboradores da empresa.

URL

https://api.grupoadvis.com.br/employee/getEmployees

JavaScript

fetch("https://api.grupoadvis.com.br/employee/getEmployees", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/employee/getEmployees' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
			"id": 18216,
			"nome": "Grupo Advis",
			"email": "advis@grupoadvis.com.br",
			"sexo": "Masculino",
			"id_cargo": 5564,
			"id_funcao": 3120,
			"id_departamento": 1682,
			"id_filial": 757,
			"data_admissao": "2019-05-02T03:00:00.000Z",
			"nivel_de_acesso": "Gerente"
	},
	{
			"id": 18719,
			"nome": "Jane Doe",
			"email": "advis2@grupoadvis.com.br",
			"sexo": "Feminino",
			"id_cargo": 5601,
			"id_funcao": 2982,
			"id_departamento": 1670,
			"id_filial": 757,
			"data_admissao": "1969-12-31T03:00:00.000Z",
			"nivel_de_acesso": "Colaborador"
	}
	]
}

Legenda

Campo	Valores possíveis
"nivel_de_acesso"	"Administrador", "Consultor", "Gerente", "Colaborador”
"sexo"	"Masculino", "Feminino"

getEmployeesByBranch

/employee GET

Requisição para obter os Colaboradores de uma determinada Filial.

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" da filial que você pode obter na /company/getBranches)

URL

https://api.grupoadvis.com.br/employee/getEmployeesByBranch/ID

JavaScript

fetch("https://api.grupoadvis.com.br/employee/getEmployeesByBranch/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/employee/getEmployeesByBranch/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
			"id": 18216,
			"nome": "Grupo Advis",
			"email": "advis@grupoadvis.com.br",
			"sexo": "Masculino",
			"id_cargo": 5564,
			"id_funcao": 3120,
			"id_departamento": 1682,
			"id_filial": 757,
			"data_admissao": "2019-05-02T03:00:00.000Z",
			"nivel_de_acesso": "Gerente"
	},
	{
			"id": 18719,
			"nome": "Jane Doe",
			"email": "advis2@grupoadvis.com.br",
			"sexo": "Feminino",
			"id_cargo": 5601,
			"id_funcao": 2982,
			"id_departamento": 1670,
			"id_filial": 757,
			"data_admissao": "1969-12-31T03:00:00.000Z",
			"nivel_de_acesso": "Colaborador"
	}
	]
}

getEmployeeDepartments

/employee GET

Requisição para obter os Departamentos de um determinado Colaborador.

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do funcionário que você pode obter na /employee/getEmployees)

URL

https://api.grupoadvis.com.br/employee/getEmployeeDepartments/ID

JavaScript

fetch("https://api.grupoadvis.com.br/employee/getEmployeeDepartments/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/employee/getEmployeeDepartments/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_departamento": 1669
		},
		{
			"id_departamento": 1682
		}
	]
}

updateEmployee

/employee PUT

Requisição para atualizar os dados de um Colaborador.

Substitua ID pelo ID do registro que deseja fazer a atualização. (neste caso o "id" do funcionário os quais você pode obter na /company/getEmployees)

URL

https://api.grupoadvis.com.br/employee/updateEmployee/ID

JavaScript

fetch("https://api.grupoadvis.com.br/employee/updateEmployee/ID", {
	"method": "PUT",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Johnny Doe",
		"id_filial" : 760,
		"id_cargo" : 5548,
		"sexo" : "Masculino",
		"data_admissao" : "2019-10-01",
		"remuneracao" : 0,
		"status" : 1,
		"lixeira" : 0,
		"id_funcao" : 2920
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request PUT \
	--url 'https://api.grupoadvis.com.br/employee/updateEmployee/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'
	--data '{
		"nome" : "Johnny Doe",
		"id_filial" : 760,
		"id_cargo" : 5548,
		"sexo" : "Masculino",
		"data_admissao" : "2019-10-01",
		"remuneracao" : 0,
		"status" : 1,
		"lixeira" : 0,
		"id_funcao" : 2920
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1
  	}
}

Legenda

Campo	Valores possíveis
"sexo"	"Masculino", "Feminino"
"data_admissao"	"YYYY-DD-MM" (Formato de data)
"lixeira"	0 (Não está na lixeira), 1 (Está na lixeira)
"status"	0 (Bloqueado), 1 (Ativo), 2 (Inativo)

Observe que podemos fazer update em todos os campos do funcionário menos o campo "email", que não pode ser alterado

updateEmployeeDepartment

/employee PUT

Requisição para atualizar os departamentos de um determinado Colaborador.

Substitua ID pelo ID do registro que deseja fazer a atualização. (neste caso o "id" do funcionário os quais você pode obter na /company/getEmployees)

URL

https://api.grupoadvis.com.br/employee/updateEmployeeDepartment/ID

JavaScript

fetch("https://api.grupoadvis.com.br/employee/updateEmployeeDepartment/ID", {
	"method": "PUT",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"id_departamento" : 1693
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request PUT \
	--url 'https://api.grupoadvis.com.br/employee/updateEmployeeDepartment/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'
	--data '{
		"id_departamento" : 1693
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1
  	}
}

insertEmployee

/employee POST

Insere um novo usuário no SIG, você pode obter usuário já cadastrado em /indicators/getEmployees

Campos Obrigatórios

Campo	Tipo
"nome"	String
"email"	String
"id_filial"	Int
"id_cargo"	Int
"id_funcao	Int

URL

https://api.grupoadvis.com.br/employee/insertEmployee

JavaScript

fetch("https://api.advistecnologia.com.br/employee/insertEmployee", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Johnny Doe",
		"id_filial" : 760,
		"id_cargo" : 5548,
		"email" : "johnny@doe.io",
		"sexo" : "Masculino",
		"data_admissao" : "2019-10-01",
		"remuneracao" : 0,
		"status" : 1,
		"lixeira" : 0,
		"id_funcao" : 2920
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
	});

CURL

curl --request POST \
	--url https://api.advistecnologia.com.br/employee/insertEmployee \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI' \
	--data '{
		"nome" : "Johnny Doe",
		"id_filial" : 760,
		"id_cargo" : 5548,
		"email" : "johnny@doe.io",
		"sexo" : "Masculino",
		"data_admissao" : "2019-10-01",
		"remuneracao" : 0,
		"status" : 1,
		"lixeira" : 0,
		"id_funcao" : 2920
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 20320
	}
}

Legenda

Campo	Valores possíveis
"sexo"	"Masculino", "Feminino"
"data_admissao"	"YYYY-DD-MM" (Formato de data)
"lixeira"	0 (Não está na lixeira), 1 (Está na lixeira)
"status"	0 (Bloqueado), 1 (Ativo), 2 (Inativo)

No momento da criação de um usuário na API um email de definição de senha com validade de 7 dias será enviado para o endereço no campo "email"

Indicadores

/indicators

Informações Úteis

Nos indicadores temos várias informações relevantes que precisam de contexto, observe as legedas abaixo. Essas informações valem para todas as requisições de /indicators

Campo: "tipo"

Valor	Significado
0	TIPO_COMUM
1	TIPO_COMPOSTO_DINAMICO
2	TIPO_COMPOSTO_CUSTOMIZADO
3	TIPO_CONSOLIDADO_DINAMICO
4	TIPO_CONSOLIDADO_CUSTOMIZADO

Campo: "meta_oculta", "meta_ajustavel"

Valor	Significado
0	setada
1	não setada

Campo: "unidade_medida"

Valor	Significado
0	UNIDADE_MOEDA
1	UNIDADE_MOEDA_CALCULO
2	UNIDADE_PERCENTUAL
3	UNIDADE_PERCENTUAL_CALCULO
4	UNIDADE_QUANTIDADE
5	UNIDADE_QUANTIDADE_CALCULO
6	UNIDADE_DIAS
7	UNIDADE_DIAS_CALCULO
8	UNIDADE_HORAS
9	UNIDADE_HORAS_CALCULO

Campo: "interpretacao"

Valor	Significado	Descrição
0	INTERPRETACAO_RM	Realizado/Meta (Mais é Melhor)
1	INTERPRETACAO_MRMAIS	Realizado/Meta (Mais é melhor = 100%)
2	INTERPRETACAO_MR	Meta/Realizado (Menos é Melhor)
3	INTERPRETACAO_MRMENOS	Realizado/Meta (Menos é melhor = 100%)
4	INTERPRETACAO_APROX	Aproximação (Mais próximo é Melhor)
5	INTERPRETACAO_MR_DENOMINADOR_MEDIO	Meta/Realizado (Denominador médio)
6	INTERPRETACAO_RM_DENOMINADOR_MEDIO	Realizado/Meta (Denominador médio)

Campo: "totalizador"

Valor	Significado
0	TOTALIZADOR_SOMA
1	TOTALIZADOR_MEDIA
2	TOTALIZADOR_ULTIMO_MES

Campo: "moeda"

Valor	Significado
0	MOEDA_REAL
1	MOEDA_DOLAR
2	MOEDA_EURO

getCommonIndicators

/indicators GET

Requisição para obter os Indicadores de tipo Comum.

URL

https://api.grupoadvis.com.br/indicators/getCommonIndicators

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getCommonIndicators", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getCommonIndicators' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
			"id": 8976,
			"nome": "Acuracidade do Estoque",
			"descricao": "Nível de acuracidade",
			"fonte": "Relatório de Estoque",
			"tipo": 0,
			"meta_oculta": 0,
			"meta_ajustavel": 0,
			"unidade_medida": 3,
			"interpretacao": 4,
			"totalizador": 2,
			"moeda": 0
	},
	{
			"id": 8977,
			"nome": "Carteira de Pedidos",
			"descricao": "Valor da carteira",
			"fonte": "",
			"tipo": 0,
			"meta_oculta": 0,
			"meta_ajustavel": 0,
			"unidade_medida": 0,
			"interpretacao": 0,
			"totalizador": 2,
			"moeda": 0
	}
	]
}

getCompoundIndicators

/indicators GET

Requisição para obter os Indicadores de tipo Composto.

URL

https://api.grupoadvis.com.br/indicators/getCompoundIndicators

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getCompoundIndicators", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getCompoundIndicators' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 9108,
		"nome": "Ticket Médio",
		"descricao": "Valor médio referente às vendas que a empresa comercializa",
		"fonte": "Relatório Contábil",
		"tipo": 1,
		"meta_oculta": 0,
		"meta_ajustavel": 0,
		"unidade_medida": 1,
		"interpretacao": 0,
		"totalizador": 0,
		"moeda": 0
	},
	{
		"id": 9368,
		"nome": "Gestão de Estoque",
		"descricao": "Estoque / Faturamento",
		"fonte": "",
		"tipo": 2,
		"meta_oculta": 0,
		"meta_ajustavel": 0,
		"unidade_medida": 0,
		"interpretacao": 0,
		"totalizador": 0,
		"moeda": 0
	}
	]
}

getIndicatorById

/indicators GET

Requisição para obter um determinado indicador da empresa. Substitua ID pelo ID do registro que deseja consumir.

URL

https://api.grupoadvis.com.br/indicators/getIndicatorById/ID

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getIndicatorById/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getIndicatorById/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
    {
		"id": 9009,
		"nome": "Receita Bruta",
		"descricao": "Valor total arrecado em vendas de bens, sem deduções",
		"fonte": "Relatório de Vendas",
		"tipo": 0,
		"meta_oculta": 0,
		"meta_ajustavel": 0,
		"unidade_medida": 0,
		"interpretacao": 0,
		"totalizador": 0,
		"moeda": 0
	}
	]
}

getCompoundReferencesById

/indicators GET

Requisição para obter as Referências configuradas para um determinado Indicador de tipo Composto. Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do indicador composto que você pode obter na /indicators/getCompoundReferencesById)

URL

https://api.grupoadvis.com.br/indicators/getCompoundReferencesById/ID

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getCompoundReferencesById/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getCompoundReferencesById/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id": 1349,
			"id_indicador_principal": 9368,
			"id_indicador": 9169,
			"id_painel_modelo": 3118,
			"origem_campo": 0,
			"origem_posicao": 0,
			"destino_campo": 0,
			"destino_posicao": 0
		},
		{
			"id": 1350,
			"id_indicador_principal": 9368,
			"id_indicador": 9366,
			"id_painel_modelo": 3179,
			"origem_campo": 0,
			"origem_posicao": 1,
			"destino_campo": 0,
			"destino_posicao": 1
		}
	]
}

getConsolidatedReferencesById

/indicators GET

Requisição para obter as Referências configuradas para um determinado Indicador de tipo Consolidado. Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do indicador consolidado que você pode obter na /indicators/getConsolidatedIndicators)

URL

https://api.grupoadvis.com.br/indicators/getConsolidatedReferencesById/ID

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getConsolidatedReferencesById/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getConsolidatedReferencesById/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
    {
		"id": 10301,
		"id_indicador_principal": 9104,
		"id_indicador": 9102,
		"id_painel_modelo": null
	},
	{
		"id": 10302,
		"id_indicador_principal": 9104,
		"id_indicador": 9103,
		"id_painel_modelo": null
	}
	]
}

getConsolidatedIndicators

/indicators GET

Requisição para obter os Indicadores de tipo Consolidado.

URL

https://api.grupoadvis.com.br/indicators/getConsolidatedIndicators

JavaScript

fetch("https://api.grupoadvis.com.br/indicators/getConsolidatedIndicators", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/indicators/getConsolidatedIndicators' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 9104,
		"nome": "Receita de Peças e Serviços",
		"descricao": "Valor arrecadado em comercialização de peças e serviços",
		"fonte": "Relatório Financeiro",
		"tipo": 3,
		"meta_oculta": 0,
		"meta_ajustavel": 0,
		"unidade_medida": 0,
		"interpretacao": 0,
		"totalizador": 0,
		"moeda": 0
	},
	{
		"id": 9131,
		"nome": "Margem Bruta - R1",
		"descricao": "Percentual bruto de rentabilidade na Região 1",
		"fonte": "Relatório Financeiro",
		"tipo": 4,
		"meta_oculta": 0,
		"meta_ajustavel": 0,
		"unidade_medida": 3,
		"interpretacao": 0,
		"totalizador": 0,
		"moeda": 0
	}
	]
}

insertCommonIndicator

/indicators POST

Insere indicadores do tipo comum, os quais você obtem na /indicators/getCommonIndicators

Campos Obrigatórios

Campo	Tipo
"nome"	String

URL

https://api.grupoadvis.com.br/indicators/insertCommonIndicator

JavaScript

fetch("https://api.advistecnologia.com.br/indicators/insertCommonIndicator", {
"method": "POST",
"headers": {
	"token": "SEU_TOKEN_AQUI",
	"Content-Type": "application/json",
            "Accept-Encoding": "gzip,deflate"
},
"body": {
	"nome" : "Indicador Comum",
	"descricao" : "Este é um indicador comum",
	"fonte" : "Fonte qualquer",
	"meta_oculta" : 1,
	"meta_ajustavel" : 1,
	"unidade_medida" : 0,
	"interpretacao" : 0,
	"totalizador" : 0,
	"moeda" : 0
}
})
.then(response => {
console.log(response);
})
.catch(err => {
console.error(err);
});

CURL

curl --request POST \
--url https://api.advistecnologia.com.br/indicators/insertCommonIndicator \
--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
--header 'token: SEU_TOKEN_AQUI' \
--data '{
	"nome" : "Indicador Comum",
	"descricao" : "Este é um indicador comum",
	"fonte" : "Fonte qualquer",
	"meta_oculta" : 1,
	"meta_ajustavel" : 1,
	"unidade_medida" : 0,
	"interpretacao" : 0,
	"totalizador" : 0,
	"moeda" : 0
}'

Exemplo de Resposta JSON

{
"response": {
    "status": "success",
    "affectedRows": 1,
    "insertId": 14386
}
}

Painéis

/panels

getGroups

/panels GET

Requisição para obter os Grupos de Painéis cadastrados na empresa.

URL

https://api.grupoadvis.com.br/panels/getGroups

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getGroups", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getGroups' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 648,
		"id_grupo": null,
		"nome": "Vendas",
		"ordem": 2
	},
	{
		"id": 649,
		"id_grupo": null,
		"nome": "Pós-Vendas",
		"ordem": 3
	}
	]
}

getPanels

/panels GET

Requisição para obter os Painéis cadastrados na empresa

URL

https://api.grupoadvis.com.br/panels/getPanels

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getPanels", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getPanels' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id": 3116,
		"id_gmr_processo": 88,
		"nome": "Aprimorar a Gestão do Estoque",
		"id_grupo": 651,
		"status": 1,
		"desativado": 0,
		"nome_modelo_painel": "Financeiro",
		"status_modelo_painel": 1,
		"data_cadastro": "2019-08-19T19:02:38.000Z",
		"confidencial": 0,
		"base": 3115,
		"id_painel_modelo": 3183,
		"ordem": null,
		"id_painel_ap": null
	  },
	  {
		"id": 3116,
		"id_gmr_processo": 113,
		"nome": "Aprimorar a Gestão do Estoque",
		"id_grupo": 651,
		"status": 1,
		"desativado": 0,
		"nome_modelo_painel": "Financeiro",
		"status_modelo_painel": 1,
		"data_cadastro": "2019-08-19T19:02:38.000Z",
		"confidencial": 0,
		"base": 3115,
		"id_painel_modelo": 3183,
		"ordem": null,
		"id_painel_ap": null
	}
	]
}

Legenda

Campo	Valor	Significado
"desativado"	0	Ativo
"desativado"	1	Inativo

getProgressPanelCell

/panels GET

Requisição para obter o Acompanhamento de Resultados de um determinado indicador, painel, ano e mês, ou seja, os valores de uma célula do painel de acompanhamento.

Substitua ID_PAINEL pelo ID do registro que deseja. (neste caso o "id" do painél, os quais você pode obter na /company/getPanels)

Substitua ID_INDICADOR pelo ID do registro que deseja. (neste caso o "id" do indicador, os quais você pode obter nos GET's da rotas /indicator

Mês e ano:

Campo	Range de valores (Int)
"mes"	1 ~ 12
"ano"	0 ~ 9999

URL

https://api.grupoadvis.com.br/panels/getProgressPanelCell/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getProgressPanelCell/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getProgressPanelCell/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_indicador": 9009,
			"id_gmr_painel": 3779,
			"mes": 2,
			"ano": 2020,
			"peso": 50,
			"auxiliar": 0,
			"meta_numerador": 2500000,
			"meta_denominador": null,
			"meta_ajustada_numerador": null,
			"meta_ajustada_denominador": null,
			"realizado_numerador": 500000,
			"realizado_denominador": null
	  	}
	]
}

getProgressPanelRow

/panels GET

Requisição para obter o Acompanhamento de Resultados de um determinado indicador, painel e processo GMR, ou seja, os valores de uma fila do painel de acompanhamento.

Substitua ID_GMR pelo ID do registro que deseja. (neste caso o "id" do processo GMR, os quais você pode obter na /processes/getGmrProcesses)

Substitua ID_PAINEL pelo ID do registro que deseja. (neste caso o "id" do painél, os quais você pode obter na /company/getPanels)

Substitua ID_INDICADOR pelo ID do registro que deseja. (neste caso o "id" do indicador, os quais você pode obter nos GET's da rotas /indicator

URL

https://api.grupoadvis.com.br/panels/getProgressPanelRow/idGmr/ID_GMR/panel/ID_PAINEL/indicator/ID_INDICADOR

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getProgressPanelRow/idGmr/ID_GMR/panel/ID_PAINEL/indicator/ID_INDICADOR", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getProgressPanelRow/idGmr/ID_GMR/panel/ID_PAINEL/indicator/ID_INDICADOR' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id_indicador": 9009,
		"id_gmr_painel": 3779,
		"mes": 1,
		"ano": 2020,
		"peso": 50,
		"auxiliar": 0,
		"meta_numerador": 2500000,
		"meta_denominador": null,
		"meta_ajustada_numerador": null,
		"meta_ajustada_denominador": null,
		"realizado_numerador": 3000000,
		"realizado_denominador": null
	  },
	  {
		"id_indicador": 9009,
		"id_gmr_painel": 3779,
		"mes": 2,
		"ano": 2020,
		"peso": 50,
		"auxiliar": 0,
		"meta_numerador": 2500000,
		"meta_denominador": null,
		"meta_ajustada_numerador": null,
		"meta_ajustada_denominador": null,
		"realizado_numerador": 500000,
		"realizado_denominador": null
	  }
}

Requisição usualmente retornará 12 elementos, observe o campo "mes", que irá nessas ocasiões de 1 ~ 12.

getAccessPanel

/panels GET

Requisição para obter as Permissões de Acesso de um determinado Painel e Processo GMR cadastrados na empresa.

Substitua ID_GMR_PROCESSO pelo ID do registro que deseja. (neste caso o "id" do processo gmr, os quais você pode obter nos GET's da rotas /processes

Substitua ID_GMR_PAINEL pelo ID do registro que deseja. (neste caso o "id" do painél, os quais você pode obter na /company/getPanels)

URL

https://api.grupoadvis.com.br/panels/getAccessPanel/process/ID_GMR_PROCESSO/panel/ID_GMR_PAINEL

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getAccessPanel/process/ID_GMR_PROCESSO/panel/ID_GMR_PAINEL", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getAccessPanel/process/ID_GMR_PROCESSO/panel/ID_GMR_PAINEL' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_gmr_processo": 113,
			"id_gmr_painel": 3779,
			"id_colaborador": 18819,
			"acesso": 0,
			"permissao": 1
	  	}
	]
}

Legenda

Campo	Valor	Significado
"permissao"	0	Permissão apenas para visualizar o painel.
"permissao"	1	Permissão para editar os valores do painel.
"acesso"	0	Acesso como Responsável
"acesso"	1	Acesso como Superior
"acesso"	2	Acesso como Equipe
"acesso"	3	Acesso como Facilitador

getAccessPanelByEmployee

/panels GET

Requisição para obter as Permissões de Acesso de todos os Painéis e Processos GMR de um determinado Colaborador.

Substitua ID_COLABORADOR pelo ID do registro que deseja. (neste caso o "id" do processo gmr, os quais você pode obter nos GET's da rotas /employee

URL

https://api.grupoadvis.com.br/panels/getAccessPanelByEmployee/ID_COLABORADOR

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getAccessPanelByEmployee/ID_COLABORADOR", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getAccessPanelByEmployee/ID_COLABORADOR' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_gmr_processo": 88,
			"id_gmr_painel": 3054,
			"id_colaborador": 18819,
			"acesso": 2,
			"permissao": 0
	  	},
	  	{
			"id_gmr_processo": 113,
			"id_gmr_painel": 3054,
			"id_colaborador": 18819,
			"acesso": 2,
			"permissao": 0
	  	}
	]
}

Legenda

Campo	Valor	Significado
"permissao"	0	Permissão apenas para visualizar o painel.
"permissao"	1	Permissão para editar os valores do painel.
"acesso"	0	Acesso como Responsável
"acesso"	1	Acesso como Superior
"acesso"	2	Acesso como Equipe
"acesso"	3	Acesso como Facilitador

getModels

/panels GET

Requisição para obter os Modelos e Submodelos de Painéis cadastrados na empresa.

Aqui se consome os modelos de painéis da tabela painel_modelo.

URL

https://api.grupoadvis.com.br/panels/getModels

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getModels", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getModels' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id": 3093,
			"id_grupo": null,
			"nome": "Gerência de Vendas - Região 1",
			"data_cadastro": "2019-08-19T16:45:54.000Z",
			"status": 1,
			"confidencial": 0,
			"ordem": null,
			"base": 0
	  	},
	 	{
			"id": 3094,
			"id_grupo": 648,
			"nome": "GV Região 1",
			"data_cadastro": "2019-08-19T16:45:54.000Z",
			"status": 1,
			"confidencial": 0,
			"ordem": null,
			"base": 3093
	  	}
	]
}

Legenda

Campo	Valor	Significado
"confidencial"	0	Modelo não confidencial
"confidencial"	1	Modelo confidencial
"status"	0	Modelo desativado
"status"	1	Modelo ativo
"base"	0	É um Modelo Base
"base"	ID_PAINEL_MODELO	É um submodelo do ID_PAINEL_MODELO
"ordem"	NULL	Ordem dentro do grupo não definida
"ordem"	Int	Inteiro representando a posição do submodelo no Grupo ao qual pertence

getModelById

/panels GET

Requisição para obter um determinado Modelo ou Submodelo de Painel cadastrados na empresa.

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do modelo de painél que você pode obter na /panels/getModels)

URL

https://api.grupoadvis.com.br/panels/getModelById/ID

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getModelById/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getModelById/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id": 3094,
			"id_grupo": 648,
			"nome": "GV Região 1",
			"data_cadastro": "2019-08-19T16:45:54.000Z",
			"status": 1,
			"confidencial": 0,
			"ordem": null,
			"base": 3093
		}
	]
}

Legenda

Campo	Valor	Significado
"confidencial"	0	Modelo não confidencial
"confidencial"	1	Modelo confidencial
"status"	0	Modelo desativado
"status"	1	Modelo ativo
"base"	0	É um Modelo Base
"base"	ID_PAINEL_MODELO	É um submodelo do ID_PAINEL_MODELO
"ordem"	NULL	Ordem dentro do grupo não definida
"ordem"	Int	Inteiro representando a posição do submodelo no Grupo ao qual pertence

getModelIndicators

/panels GET

Requisição para obter os Indicadores cadastrados para um determinado Modelo de Painel. Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do modelo de painél que você pode obter na /indicators/getModels)

URL

https://api.grupoadvis.com.br/panels/getModelIndicators/ID

JavaScript

fetch("https://api.grupoadvis.com.br/panels/getModelIndicators/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/getModelIndicators/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_painel_modelo": 4053,
			"id_indicador": 9009,
			"inicio_mes": 0,
			"inicio_ano": 0,
			"fim_mes": 0,
			"fim_ano": 0,
			"ordem": 1
		},
		{
			"id_painel_modelo": 4053,
			"id_indicador": 9475,
			"inicio_mes": 0,
			"inicio_ano": 0,
			"fim_mes": 0,
			"fim_ano": 0,
			"ordem": 2
		}
	]
}

updatePanel

/panels PUT

Substitua ID pelo ID do registro que deseja fazer a atualização. (neste caso o "id" do painél, os quais você pode obter na /company/getPanels)

URL

https://api.grupoadvis.com.br/panels/updatePanel/ID

JavaScript

fetch("https://api.grupoadvis.com.br/panels/updatePanel/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"nome" : "Painel Ativo",
		"desativado" : 0
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/updatePanel/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'
	--data '{
		"nome" : "Painel Ativo",
		"desativado" : 0
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1
  	}
}

Legenda

Campo	Valor	Significado
"desativado"	0	Ativo
"desativado"	1	Inativo

updateProgressPanel

/panels PUT

Substitua ID_PAINEL pelo ID do registro que deseja fazer a atualização. (neste caso o "id" do painél, os quais você pode obter na /company/getPanels)

Substitua ID_INDICADOR pelo ID do registro que deseja fazer a atualização. (neste caso o "id" do indicador, os quais você pode obter nos GET's da rotas /indicator

Mês e ano:

Campo	Range de valores (Int)
"mes"	1 ~ 12
"ano"	0 ~ 9999

Informações Úteis

Os valores enviados no body dessa requisição devem sempre ser numéricos, pois passarão por um tratamento e serão inseridos no banco sempre como Float (%.2f / 0.00).

Se o indicador do ID_INDICADOR não tiver o campo "meta_ajustavel" = 1 os campos com os prefixos meta_ajustada_* serão ignorados nesta requisição, mesmo que você passe valores neles.

URL

https://api.grupoadvis.com.br/panels/updateProgressPanel/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO

JavaScript

fetch("https://api.grupoadvis.com.br/panels/updateProgressPanel/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"meta_numerador" : 456.0,
		"meta_denominador" : 123.234,
		"meta_ajustada_numerador" : 456.1,
		"meta_ajustada_denominador" : 123,
		"realizado_numerador" : 456.8322,
		"realizado_denominador" : 123
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/panels/updateProgressPanel/panel/ID_PAINEL/indicator/ID_INDICADOR/month/MES/year/ANO' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'
	--data '{
		"meta_numerador" : 456.0,
		"meta_denominador" : 123.234,
		"meta_ajustada_numerador" : 456.1,
		"meta_ajustada_denominador" : 123,
		"realizado_numerador" : 456.8322,
		"realizado_denominador" : 123
	}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1
  	}
}

Legenda

Campo	Valor	Significado
"desativado"	0	Ativo
"desativado"	1	Inativo

insertAccessPanel

/panels POST

Insere painéis de acesso.

Campos Obrigatórios

Campo	Tipo
"id_gmr_processo"	Int
"id_colaborador"	Int
"id_gmr_painel"	Int

URL

https://api.grupoadvis.com.br/panels/insertAccessPanel

JavaScript

fetch("https://api.advistecnologia.com.br/panels/insertAccessPanel", {
	"method": "POST",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": {
		"id_gmr_processo" : 88,
		"id_colaborador" : 18723,
		"id_gmr_painel" : 3040,
		"acesso": 2,
		"permissao": 1
	}
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request POST \
--url https://api.advistecnologia.com.br/panels/insertAccessPanel \
--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
--header 'token: SEU_TOKEN_AQUI' \
--data '{
	"id_gmr_processo" : 88,
	"id_colaborador" : 18723,
	"id_gmr_painel" : 3040,
	"acesso": 2,
	"permissao": 1
}'

Exemplo de Resposta JSON

{
	"response": {
		"status": "success",
		"affectedRows": 1,
		"insertId": 0
	}
}

Legenda

Campo	Valor	Significado
"permissao"	0	Permissão apenas para visualizar o painel.
"permissao"	1	Permissão para editar os valores do painel.
"acesso"	0	Acesso como Responsável
"acesso"	1	Acesso como Superior
"acesso"	2	Acesso como Equipe
"acesso"	3	Acesso como Facilitador

Processos

/processes

getGmrProcesses

/processes GET

Requisição para obter os processos GMR cadastrados na empresa.

Aqui se consome os processos da tabela gmr_processo.

URL

https://api.grupoadvis.com.br/processes/getGmrProcesses

JavaScript

fetch("https://api.grupoadvis.com.br/processes/getGmrProcesses", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/processes/getGmrProcesses' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id": 88,
			"nome": "GMR 2019",
			"inicio_mes": 1,
			"inicio_ano": 2019,
			"fim_mes": 12,
			"fim_ano": 2019,
			"encerrado": 0
		},
		{
			"id": 113,
			"nome": "GMR 2020",
			"inicio_mes": 1,
			"inicio_ano": 2020,
			"fim_mes": 12,
			"fim_ano": 2020,
			"encerrado": 0
		}
	]
}

Legenda

Campo	Valor	Significado
"encerrado"	0	Ativo
"encerrado"	1	Inativo

getGmrProcessById

/processes GET

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do processo que você pode obter na /processes/getGmrProcesses)

URL

https://api.grupoadvis.com.br/processes/getGmrProcessById/ID

JavaScript

fetch("https://api.grupoadvis.com.br/processes/getGmrProcessById/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/processes/getGmrProcessById/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
	{
		"id_gmr_processo": 88,
		"nome": "GMR 2019",
		"inicio_mes": 1,
		"inicio_ano": 2019,
		"fim_mes": 12,
		"fim_ano": 2019,
		"encerrado": 0,
		"minimo": 0,
		"maximo": 70,
		"cor": "#9d261d"
	},
	{
		"id_gmr_processo": 88,
		"nome": "GMR 2019",
		"inicio_mes": 1,
		"inicio_ano": 2019,
		"fim_mes": 12,
		"fim_ano": 2019,
		"encerrado": 0,
		"minimo": 70,
		"maximo": 90,
		"cor": "#ffc40d"
	},
	{
		"id_gmr_processo": 88,
		"nome": "GMR 2019",
		"inicio_mes": 1,
		"inicio_ano": 2019,
		"fim_mes": 12,
		"fim_ano": 2019,
		"encerrado": 0,
		"minimo": 90,
		"maximo": 100,
		"cor": "#46A546"
	}
	]
}

Legenda

Campo	Valor	Significado
"encerrado"	0	Ativo
"encerrado"	1	Inativo

getGmrProcessIntervals

/processes GET

Requisição para obter os intervalos cadastrados para um determinado Processo GMR da empresa.

Substitua ID pelo ID do registro que deseja consumir. (neste caso o "id" do processo que você pode obter na /processes/getGmrProcesses)

URL

https://api.grupoadvis.com.br/processes/getGmrProcessIntervals/ID

JavaScript

fetch("https://api.grupoadvis.com.br/processes/getGmrProcessIntervals/ID", {
	"method": "GET",
	"headers": {
		"token": "SEU_TOKEN_AQUI",
		"Content-Type": "application/json",
                "Accept-Encoding": "gzip,deflate"
	},
	"body": false
	})
	.then(response => {
	console.log(response);
	})
	.catch(err => {
	console.error(err);
});

CURL

curl --request GET \
	--url 'https://api.grupoadvis.com.br/processes/getGmrProcessIntervals/ID' \
	--header 'Accept-Encoding: gzip,deflate' \
        --header 'Content-Type: application/json' \ 
	--header 'token: SEU_TOKEN_AQUI'

Exemplo de Resposta JSON

{
	"response": [
		{
			"id_gmr_processo": 88,
			"minimo": 0,
			"maximo": 70,
			"cor": "#9d261d"
		},
		{
			"id_gmr_processo": 88,
			"minimo": 70,
			"maximo": 90,
			"cor": "#ffc40d"
		},
		{
			"id_gmr_processo": 88,
			"minimo": 90,
			"maximo": 100,
			"cor": "#46A546"
		}
	]
}

Como funciona a autenticação?

JavaScript

CURL

Aviso

Empresa

getDepartments

URL

JavaScript

CURL

Exemplo de Resposta JSON

Legenda

getBranches

URL

JavaScript

CURL

Exemplo de Resposta JSON

getRoles

URL

JavaScript

CURL

Exemplo de Resposta JSON

getFunctionsByRole

URL

JavaScript

CURL

Exemplo de Resposta JSON

insertDepartment

Campos Obrigatórios

URL

JavaScript

CURL

Exemplo de Resposta JSON

insertBranch

Campos Obrigatórios

URL

JavaScript

CURL

Exemplo de Resposta JSON

insertRole

Campos Obrigatórios

URL

JavaScript

CURL

Exemplo de Resposta JSON

insertFunction

Campos Obrigatórios

URL

JavaScript

CURL

Exemplo de Resposta JSON

Funcionário

getEmployees

URL

JavaScript

CURL

Exemplo de Resposta JSON

Legenda

getEmployeesByBranch

URL

JavaScript

CURL

Exemplo de Resposta JSON

getEmployeeDepartments

URL

JavaScript

CURL

Exemplo de Resposta JSON

updateEmployee

URL

JavaScript

CURL

Exemplo de Resposta JSON

Legenda

updateEmployeeDepartment

URL

JavaScript

CURL

Exemplo de Resposta JSON

insertEmployee

Campos Obrigatórios