Qualiex API Documentation v1.0
Esta é a documentação da API para integração com o Qualiex.
https://api.qualiex.com.br:443/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])
Retorno
- Token para ser utilizado em outros métodos.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Tokens/New?cnpj=01234567000123&email=teste@empresa.com.br&password=123
Info Informações sobre o token.
(GET,POST) /v1/Tokens/Info(string token, [string dataFormat])
Retorno
- Dados do token informado, com os campos "UnitName", "UnitIdentifier", "UserName", "UserEmail", "UserIdentifier", "RequestDate", "ExpirationDate" e "UserIP".
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Tokens/Info?token=pmS9CDvY5QFeem8lhlyB
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])
Retorno
- Lista dos usuários cadastrados.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Users?token=pmS9CDvY5QFeem8lhlyB&fields=name,email&dataFormat=xml&orderBy=1
[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])
Retorno
- Lista das pastas cadastradas no módulo Docs.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Folders?token=pmS9CDvY5QFeem8lhlyB&fields=name&identifier=OF3NFM8JF6VNV3P
Save Método para cadastrar ou editar pastas.
(GET,POST,PUT) /v1/Folders/Save(string token, string jsonData, [string parentIdentifier])
Retorno
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Folders/Save?token=pmS9CDvY5QFeem8lhlyB&jsonData={Code:"DOC",Name:"Folder1"}&parentIdentifier=OF3NFM8JF6VNV3P
Delete Método para remover pastas.
(GET,POST,DELETE) /v1/Folders/Delete(string token, string identifier)
Retorno
-
JSON seguindo o modelo:
{"Success":true}
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Folders/Delete?token=pmS9CDvY5QFeem8lhlyB&identifier=OF3NFM8JF6VNV3P
[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])
Retorno
- Lista dos arquivos/documentos de uma pasta.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Files?token=pmS9CDvY5QFeem8lhlyB&folderIdentifier=OF3NFM8JF6VNV3P&fields=code,name,extension,revision_date
Upload Método para enviar novos documentos.
(POST) /v1/Files/Upload(string token, string jsonData)
Download Método para baixar documentos.
(GET|POST) /v1/Files/Download(string token, string identifier, [int revision], [int justification])
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)
ConfirmReading Método para confirmar a leitura de um documento.
(GET|POST) /v1/Docs/ConfirmReading(string token, string identifier, [int revision])
Retorno
- Resultado da confirmação de leitura.
ViewFile Método para visualizar um documento.
(GET|POST) /v1/Docs/ViewFile(string token, string identifier, [int revision])
Retorno
- Visualização do documento.
[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])
Retorno
- Lista das coletas cadastradas.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators?token=pmS9CDvY5QFeem8lhlyB&code=api&dataFormat=xml&orderBy=1
Save Método para cadastrar ou editar coletas.
(GET,POST,PUT) /v1/Indicators/SaveAcquirings([string token], [string identifier], [string jsonData])
Retorno
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/SaveAcquirings?token=pmS9CDvY5QFeem8lhlyB&jsonData={"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"}
Delete Método para remover as coletas cadastradas.
(GET,POST,DELETE) /v1/Indicators/DeleteAcquirings([string token], [string identifier])
Retorno
-
JSON seguindo o modelo:
{"Success":true}
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/DeleteAcquirings?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV
GetAcquiringValues Método para listar os valores da coletas.
(GET,POST) /v1/Indicators/GetAcquiringValues([string token], [string identifier], [string dataFormat], [int limit])
Retorno
- Lista com os valores da coleta.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/GetAcquiringValues?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV&dataFormat=xml&orderBy=1
GetAcquiringPageValues Método para listar os valores da coletas paginados.
(GET,POST) /v1/Indicators/GetAcquiringPageValues([string token], [string identifier], [string dataFormat], [int limit])
Retorno
- Lista com os valores da coleta.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/GetAcquiringPageValues?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV
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])
Retorno
-
JSON seguindo o modelo:
{"Success":true}
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/AddAcquiringValues?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV&counter=1&value=100&comments=Comentarios
- https://api.qualiex.com.br:443/v1/Indicators/AddAcquiringValues?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV&date=2024-11&value=100&comments=Comentarios
IgnoreAcquiringValues Método para ignorar os valores das coletas.
(GET,POST,PUT) /v1/Indicators/IgnoreAcquiringValues([string token], [string identifier], [boolean ignored], [int counter])
Retorno
-
JSON seguindo o modelo:
{"Success":true}
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Indicators/IgnoreAcquiringValues?token=pmS9CDvY5QFeem8lhlyB&identifier=J17RUFH6Q7HASFV&counter=1&ignored=true
[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)
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)
Retorno
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Metrology/GetLastDownload?token=pmS9CDvY5QFeem8lhlyB&CNPJ=00000000000000&initialDate=2024-10-20&endDate=2024-11-20
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)
Retorno
-
JSON seguindo o modelo:
[{"Identifier":"LSAHGAM2DJGHTC7","Code":"00001/2015","Date":"2015-08-14","InstrumentCode":"P001","InstrumentType":"Paquímetro Digital","SupplierName":"Fornecedor","SupplierCNPJ":"00000000000000","CalibrationType":"RBC","Observation":null,"UnitName":"Unidade","UnitCNPJ":"00000000000000"}]
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Metrology/GetCertificates?token=pmS9CDvY5QFeem8lhlyB&CNPJUnits=00000000000000::00000000000001::00000000000002
DownloadCertificates Método para realizar o download dos dados dos certificados de calibrações.
(GET,POST) /v1/Metrology/DownloadCertificates(string token, string identifiers)
Retorno
-
JSON seguindo o modelo:
[{"Identifier":"LSAHGAM2DJGHTC7","Code":"00001/2015","Date":"2015-08-14","InstrumentCode":"P001","InstrumentType":"Paquímetro Digital","SupplierName":"Fornecedor","SupplierCNPJ":"00000000000000","CalibrationType":"RBC","Observation":null,"UnitName":"Unidade","UnitCNPJ":"00000000000000"}]
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Metrology/DownloadCertificates?token=pmS9CDvY5QFeem8lhlyB&identifiers=LSAHGAM2DJGHTC7::JVBERi0xLjQNCiX
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)
Retorno
-
JSON seguindo o modelo:
{"Success": true}
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).
OccurrenceGetFlowFields Método para listar os campos de uma ocorrência do Tracker2.
(GET,POST,PUT) /v1/Tracker/OccurrenceGetFlowFields(string token, string type)
OccurrenceSaveV2 Método para criar uma nova ocorrência no Tracker V2.
(GET,POST,PUT) /v1/Tracker/OccurrenceSaveV2(string token, string jsonData)
OccurrenceSaveFields Método para salvar os valores de uma ocorrência no Tracker V2.
(GET,POST,PUT) /v1/Tracker/OccurrenceSaveFields(string token, string jsonData)
Retorno
-
JSON seguindo o modelo:
{"Success": true}
SaveAttachment Método para enviar anexo das ocorrências.
(GET,POST,PUT) /v1/Tracker/SaveAttachment(string token, string jsonData)
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])
Retorno
- Resultado da consulta pré-definida.
Exemplo (GET)
- https://api.qualiex.com.br:443/v1/Query?token=pmS9CDvY5QFeem8lhlyB&identifier=OF3NFM8JF6VNV3P