Collection Postman
Faça o download da collection do Postman abaixo:
Introdução
A API SysOp possui atualmente dois endpoints:
/api/db — Consiste na execução de uma única query SQL, utilizada para executar um comando ou retornar dados.
/api/script — Consiste na execução de um conjunto de queries SQL, processadas sequencialmente, permitindo a execução de comandos em ordem, como em um script.
Em ambas as requisições, algumas informações são retornadas nos headers:
x-api-versao — Versão da API.
x-api-total — Quantidade de registros retornados pela query.
x-api-driver — Driver utilizado para o acesso ao banco de dados.
Endpoint /api/db
Nesta requisição, é utilizada a propriedade query, do tipo string, onde deve ser informada a instrução SQL desejada.
Para operações de DELETE, INSERT e UPDATE, não há retorno de dados — a resposta será apenas um array vazio ([]) com status 200.
Já ao utilizar um SELECT, os dados solicitados são retornados no formato JSON, conforme o exemplo abaixo.
Também está disponível a propriedade callback, que pode ser utilizada em cenários em que, por exemplo, a propriedade query contém um INSERT e é necessário capturar o último ID gerado na tabela. Ou seja, a propriedade query é responsável por executar o comando, enquanto a callback é utilizada para retornar alguma informação resultante dessa execução.
Veja o exemplo abaixo:
Endpoint /api/script
Nesta requisição, a propriedade script, do tipo array de strings, é utilizada para informar uma lista de comandos SQL que serão executados no lado do servidor.
Em caso de sucesso, a resposta será sempre OK, com status 200, conforme o exemplo abaixo.
Os comandos SQL são executados de forma sequencial e, caso algum deles falhe, o processo é imediatamente interrompido, sendo retornado o erro com status 500, conforme o exemplo abaixo.
Formatações
Para inserir quebras de linha, utilize a palavra _newline_.
Para representar aspas duplas, utilize chr(34).
Exemplo:
INSERT INTO usuarios (nome, descricao) VALUES (chr(34)João Silvachr(34), chr(34)Linha 1_newline_Linha 2chr(34))
