Qualiex API Documentation v1.0

Esta é a documentação da API para integração com o Qualiex.
http://api.qualiex.com.br/v1

Tokens

Para acessar qualquer funcionalidade desta API é necessário um Token de acesso, que será obtido após a autenticação do usuário.
Abaixo estão os métodos para trabalhar com os Tokens.

New Método para pegar o token de acesso aos outros métodos informando usuário/senha válidos.

(GET,POST) /v1/Tokens/New([string cnpj], string email, string password, [int duration], [string dataFormat])
ParâmetroValorTipoDescrição
string CNPJ da empresa.
string E-mail de um usuário válido.
string Senha do usuário.
int Tempo que o token permanecerá válido antes de expirar (em minutos). O tempo padrão é 30min.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".

Retorno

Exemplo (GET)

Info Informações sobre o token.

(GET,POST) /v1/Tokens/Info(string token, [string dataFormat])
ParâmetroValorTipoDescrição
string Token a ser consultado.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".

Retorno

Exemplo (GET)

Usuários

Os usuários do Qualiex podem ser consultados através do método abaixo.

Users Método para consultar os usuários cadastrados.

(GET,POST) /v1/Users(string token, [string email], [string fields], [string dataFormat], [int orderBy], [int offset], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string E-mail do usuário a ser consultado.
string Campos a serem consultados. Exemplo: "fields=name,email,birthday".
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Ordenação dos registros consultados. Por padrão os registros são consultados na ordem que foram cadastrados.
int Registros a serem excluídos no início da consulta (pode ser utilizado para paginação dos resultados).
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados).

Retorno

Exemplo (GET)

[Docs] Pastas

As pastas do módulo Docs podem ser cadastradas, editadas, consultadas e removidas através dos métodos abaixo.

Folders Método para consultar as pastas cadastradas.

(GET,POST) /v1/Folders(string token, [string identifier], [string fields], [string dataFormat], [int orderBy], [int offset], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da pasta a ser consultada.
string Campos a serem consultados. Exemplo: "fields=name".
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Ordenação dos registros consultados. Por padrão os registros são consultados na ordem que foram cadastrados.
int Registros a serem excluídos no início da consulta (pode ser utilizado para paginação dos resultados).
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados).

Retorno

Exemplo (GET)

Save Método para cadastrar ou editar pastas.

(GET,POST,PUT) /v1/Folders/Save(string token, string jsonData, [string parentIdentifier])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Dados das pastas a serem gravadas. Exemplo:
{
	Code:"DOC",
	Name:"Folder 1",
	Children:[
		{Code:"DOC",Name:"Folder 1.1"},
		{Code:"DOC",Name:"Folder 1.2"}
	]
}
string Pasta pai onde as pastas devem ser gravadas.

Retorno

Exemplo (GET)

Delete Método para remover pastas.

(GET,POST,DELETE) /v1/Folders/Delete(string token, string identifier)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da pasta.

Retorno

Exemplo (GET)

[Docs] Documentos

Com os métodos abaixo é possível consultar os documentos de uma pasta, enviar novos documentos ou removê-los.

Files Método para consultar os documentos de uma pasta.

(GET,POST) /v1/Files(string token, string folderIdentifier, [string fields], [string dataFormat], [int orderBy], [int offset], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da pasta a ser consultada.
string Campos a serem consultados. Exemplo: "fields=code,name,extension,revision_date".
string Nome do documento a ser consultado.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Ordenação dos registros consultados. Por padrão os registros são consultados na ordem que foram cadastrados.
int Registros a serem excluídos no início da consulta (pode ser utilizado para paginação dos resultados).
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados).

Retorno

Exemplo (GET)

Upload Método para enviar novos documentos.

(POST) /v1/Files/Upload(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string JSON com os dados do novo documento. Exemplo:
{
	FolderIdentifier:"OF3NFM8JF6VNV3P",
	UserIdentifier:"IKJL03MFW72MWQD",
	ClassificationName:"Procedimento",
	Name:"Novo Documento",
	Extension:".docx"
}
file Arquivo a ser enviado.

Retorno

Download Método para baixar documentos.

(GET|POST) /v1/Files/Download(string token, string identifier, [int revision], [int justification])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador do documento a ser baixado.
int Revisão do documento.
string Justificativa de download.

Retorno

PrintTokens Método para consultar informações de uma impressão através de seu token.

(GET|POST) /v1/Docs/GetPrintedDocumentByToken(string token, string identifier)
ParâmetroValorTipoDescrição
string Token da impressão
string E-mail válido para realizar a consulta.

Retorno

ConfirmReading Método para confirmar a leitura de um documento.

(GET|POST) /v1/Docs/ConfirmReading(string token, string identifier, [int revision])
ParâmetroValorTipoDescrição
string Token do Usuário
string Identificador do Arquivo.
int Revisão do Arquivo.

Retorno

ViewFile Método para visualizar um documento.

(GET|POST) /v1/Docs/ViewFile(string token, string identifier, [int revision])
ParâmetroValorTipoDescrição
string Token do Usuário
string Identificador do Arquivo.
int Revisão do Arquivo.

Retorno

[Indicators] Coletas

As coletas do módulo Indicators podem receber valores, ter valores ignorados, ser cadastradas, editadas, consultadas e removidas através dos métodos abaixo.

Acquirings Método para consultar as coletas cadastradas.

(GET,POST) /v1/Indicators([string token], [string code], [string name], [string dataFormat], [int orderBy], [int offset], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Código da coleta a ser consultada.
string Nome da coleta a ser consultada.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Ordenação dos registros consultados de acordo com a ordem que os dados são retornados, exemplo: 1 = id, 2 = identifier 3 = name etc. Por padrão os registros são consultados na ordem que foram cadastrados.
int Registros a serem excluídos no início da consulta (pode ser utilizado para paginação dos resultados).
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados).

Retorno

Exemplo (GET)

Save Método para cadastrar ou editar coletas.

(GET,POST,PUT) /v1/Indicators/SaveAcquirings([string token], [string identifier], [string jsonData])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta, para edição o preenchimento desse campo é obrigatório.
string Com exceção do campo (), todos os outros campos são obrigatórios
Para realizar edição, deve-se preencher o campo (), caso esse não seja preenchido o sistema irá cadastrar a coleta.
No campo () deve ser enviado uma string exatamente igual aos valores a seguir:
  • mensal
  • bimestral
  • trimestral
  • quadrimestral
  • semestral
  • anual
  • semanal
  • todos os dias
  • dias da semana

No campo () deve ser enviado a sigla exatamente igual está cadastrado no Indicators.
O campo () é um número inteiro e aceita os valores 0, -1 e -2. Exemplos:
  • Uma coleta mensal cujo a data da primeira coleta for 01/05/2017 o increment = 0 representa que a primeira coleta é referente a mai/17, increment = -1 é referente a abr/17 e increment = -2 é referente a mar/17
  • Uma coleta anual cujo a data da primeira coleta for 01/05/2017 o increment = 0 representa que a primeira coleta é referente a 2017, increment = -1 é referente a 2016 e increment = -2 é referente a 2015

Ao alterar o valor dos dados () e () para valores superiores aos valores atuais, poderá perder valores das coletas já realizadas.

Cadastro de Coletas Exemplo para cadastrar coletas a partir de dados no formato JSON.

{
	"code":"PMSJ",
	"name":"Produção Mensal João da Silva",
	"firstDate":"2016-12-14",
	"howToAcquire":"Coletar os dados da produção mensal do João da Silva",
	"increment":-1,
	"acronym":"%",
	"responsibleEmail":"joaosilva@dominio.com.br",
	"frequency":"mensal"
}

Retorno

Exemplo (GET)

Delete Método para remover as coletas cadastradas.

(GET,POST,DELETE) /v1/Indicators/DeleteAcquirings([string token], [string identifier])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta a ser excluída.

Retorno

Exemplo (GET)

GetAcquiringValues Método para listar os valores da coletas.

(GET,POST) /v1/Indicators/GetAcquiringValues([string token], [string identifier], [string dataFormat], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta para listar os valores.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados). Por padrão retorna os últimos 15 valores.

Retorno

Exemplo (GET)

GetAcquiringPageValues Método para listar os valores da coletas paginados.

(GET,POST) /v1/Indicators/GetAcquiringPageValues([string token], [string identifier], [string dataFormat], [int limit])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta para listar os valores.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
int Pagina a ser consultada. Por padrão retorna a primeira página.
int Quantidade máxima de registros da consulta (pode ser utilizado para paginação dos resultados). Por padrão retorna os últimos 15 valores.

Retorno

Exemplo (GET)

AddAcquiringValues Método para inserir alterar ou remover os valores das coletas.

(GET,POST,PUT) /v1/Indicators/AddAcquiringValues(string, token, string, identifier, [decimal value], [int counter], [string date], [string comments])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta (obrigatório).
decimal Valor da coleta.
int Counter da coleta.
string Período referente à coleta. Abaixo estão alguns exemplos.
  • Coleta Diária: 2022-08-12
  • Coleta Semanal: 2022-W32
  • Coleta Mensal: 2022-08
  • Coleta Bimestral: 2022-4
  • Coleta Trimestral: 2022-3
  • Coleta Quadrimestral: 2022-2
  • Coleta Semestral: 2022-2
  • Coleta Anual: 2022
string Comentários.

Retorno

Exemplo (GET)

IgnoreAcquiringValues Método para ignorar os valores das coletas.

(GET,POST,PUT) /v1/Indicators/IgnoreAcquiringValues([string token], [string identifier], [boolean ignored], [int counter])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da coleta (obrigatório).
boolean True ou false (obrigatório).
int Counter da coleta (obrigatório).

Retorno

Exemplo (GET)

[Metrology] Calibrações

Os certificados de calibração do módulo Metrology podem ser cadastrados, editados e consultados através dos métodos abaixo.

CalibrationsSave Método para enviar os certificados de calibrações dos clientes.

(GET,POST,PUT) /v1/Metrology/ExternalCalibrationsSave(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Para enviar certificados de calibração, utilize o campo seguindo o modelo informado.
{
	"CNPJ":"00000000000000",
	"Instrument":{
		"Code":"P001",
		"InstrumentType":"Paquímetro"
	},
	"Supplier":{
		"CNPJ":"00000000000000",
		"Name":"Fornecedor"
	},
	"CalibrationType":"RBC",
	"Identifier":"LSAHGAM2DJGHTC7",
	"Code":"00001/2015",
	"Date":"2015-08-14",
	"Observation":null
}
file Arquivo a ser enviado.

Retorno

GetLastDownload Método consultar as calibrações que já foram baixadas.

(GET,POST) /v1/Metrology/GetLastDownload(string token, string CNPJ, string initialDate, string endDate, string identifiers)
ParâmetroValorTipoDescrição
string Token de autenticação.
string CNPJ do fornecedor
string Data de início da consulta (AAAA-MM-DD).
string Data de fim da consulta (AAAA-MM-DD).
string Identificadores dos certificados a serem consultados.

Retorno

Exemplo (GET)

GetCertificates Método consultar as calibrações disponíveis para serem baixadas.

(GET,POST) /v1/Metrology/GetCertificates(string token, string CNPJUnits, string CNPJSupplier, string initialDate, string endDate)
ParâmetroValorTipoDescrição
string Token de autenticação.
string CNPJ das unidades a serem consultadas (exemplo 00000000000000::00000000000000)
string CNPJ do fornecedor dos certificados.
string Data de início da consulta (AAAA-MM-DD).
string Data de fim da consulta (AAAA-MM-DD).

Retorno

Exemplo (GET)

DownloadCertificates Método para realizar o download dos dados dos certificados de calibrações.

(GET,POST) /v1/Metrology/DownloadCertificates(string token, string identifiers)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificadores dos certificados a serem baixados (exemplo LSAHGAM2DJGHTC7::JVBERi0xLjQNCiX)

Retorno

Exemplo (GET)

Tracker v1

As ocorrências do módulo Tracker v1 podem ser cadastradas através dos métodos abaixo.

OccurrenceSaveV1 Método para criar uma nova ocorrência no Tracker V1.

(GET,POST,PUT) /v1/Tracker/OccurrenceSaveV1(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Para enviar os dados do anexo, utilize o campo seguindo o modelo informado. (Os campos Unit, Type, Place, Customer e Approver podem receber o Identifier como alternativa)
{
	"Unit": "Empresa X",
	"Type": "Reclamação de cliente",
	"Priority": "Acordo não cumprido",
	"Place": "Financeiro",
	"Customer": "Empresa Y",
	"Approver": "colaborador@email.com",
	"Name": "Nova Ocorrência",
	"OccurrenceDate": "10/01/2017",
	"LimitDate": "10/05/2017",
	"Status": 1,
	"Description": "Descrição da Ocorrência"
}
                                

Retorno

Tracker v2

As ocorrências do módulo Tracker V2 podem ser cadastradas e ter seus campos preenchidos na primeira etapa definida no fluxo, normalmente a etapa de descrição da Não Conformidade. Mudanças de etapa e responsabilidade devem ser feitas dentro do módulo.

Observação: Alterações no fluxo, tipo e formulários via sistema impactam diretamente no identifier dos campos preenchidos via API. Por este motivo é importante que na integração sempre ocorra a execução do passo a passo completo, pegando os identifiers dos campos a cada chamada para então fazer o preenchimento dos mesmos.

GetOccurrenceTypeIdentifier Retorna o identifier do tipo da ocorrência (necessário para criar uma ocorrência no método OccurrenceSaveV2).

Retorno

OccurrenceGetFlowFields Método para listar os campos de uma ocorrência do Tracker2.

(GET,POST,PUT) /v1/Tracker/OccurrenceGetFlowFields(string token, string type)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identifier do tipo de ocorrência

Retorno

OccurrenceSaveV2 Método para criar uma nova ocorrência no Tracker V2.

(GET,POST,PUT) /v1/Tracker/OccurrenceSaveV2(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identifier do tipo da ocorrência.
string Identifier do responsável da ocorrência.
string Data da ocorrência.

Retorno

OccurrenceSaveFields Método para salvar os valores de uma ocorrência no Tracker V2.

(GET,POST,PUT) /v1/Tracker/OccurrenceSaveFields(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string identifier da ocorrência.
string Para visualizar os dados a serem enviados utilize o método OccurrenceGetFlowFields. Os dados devem ser enviados pelo parâmetro seguindo o modelo informado.
{
	"ASD89120BN122": "Valor do campo",
	"FDSJKL3KLFDS1": "Valor do campo 2",
	"1AJKLDS290LKS": "Valor do campo 3"
}
                                

Retorno

SaveAttachment Método para enviar anexo das ocorrências.

(GET,POST,PUT) /v1/Tracker/SaveAttachment(string token, string jsonData)
ParâmetroValorTipoDescrição
string Token de autenticação.
string Para enviar os dados do anexo, utilize o campo seguindo o modelo informado.
                {	
	                "CardIdentifier":"00000000000000",
	                "Name":"foto.png",
	                "Extension":".png",
	                "RevisionDate":"2017-04-04 15:21:00"
                }
                
file Arquivo a ser enviado.

Retorno

Query (Consultas Pré-Definidas)

As queries existem para que outros sistemas possam fazer consultas específicas no Qualiex.

Query Método para realizar consultas pré-definidas.

(GET,POST) /v1/Query(string token, string identifier, [string dataFormat], [string jsonParameters])
ParâmetroValorTipoDescrição
string Token de autenticação.
string Identificador da consulta a ser realizada.
string Formato dos dados retornados (tipo do retorno). Podem ser utilizados os valores "json", "xml" ou "csv". O valor padrão é "json".
string Parâmetros no formato JSON a serem utilizados na consulta.

Retorno

Exemplo (GET)