API REST de banco de dados: transforme qualquer consulta SQL em um endpoint.

API REST do banco de dados · o hub

Transforme qualquer coisa consulta SQL em um API REST ponto final

Escreva uma consulta no Construtor de Consultas usando qualquer um dos 59 conectores e clique em Novo ponto finalVocê tem um URL em api.querystreams.com com sua própria chave. O SQL é executado em modo somente leitura no Agente que já contém seus dados; os chamadores recebem JSON ou CSV e nunca veem o SQL, o esquema ou as credenciais. Não é necessário hospedar nenhum servidor, nem abrir nenhuma porta, e todos os planos, incluindo o gratuito, incluem essa funcionalidade. Esta página é uma visão geral; cada conector tem seu próprio guia abaixo.

Aproximadamente 90 segundos a partir de uma consulta salva Nenhum servidor para hospedar Os dados permanecem na sua rede. Uma chave por chamador, revogue a qualquer momento.

O resultado final será o que você obterá.

Uma URL que retorna as linhas de uma consulta salva para qualquer pessoa que possua a chave, testada no console do portal antes de ser compartilhada. Assim:

{
  "cidade": "Seattle"
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"city": "Seattle"}'

{
  "colunas": [ { "nome": "id_do_cliente", "tipo": "inteiro" }, { "nome": "nome", "tipo": "corda" }, { "nome": "cidade", "tipo": "corda" } ],
  "fileiras": [
    { "id_do_cliente": 1042, "nome": "Comerciantes do Vento Norte", "cidade": "Seattle" },
    { "id_do_cliente": 1057, "nome": "Alpine Outfitters", "cidade": "Denver" },
    { "id_do_cliente": 1063, "nome": "Alimentos do Porto", "cidade": "Halifax" }
  ],
  "meta": { "contagem_de_linhas": 3, "duração_do_agente_ms": 41, "id_da_solicitação": "req_7Hq2mKd9" }
}

A maioria das ferramentas que implementam uma API REST em um banco de dados, como PostgREST, Hasura, DreamFactory, Directus e os frameworks que você mesmo criaria, expõem o esquema: cada tabela se torna um endpoint e o usuário navega por ela. O Query Streams faz o oposto. Uma consulta salva define exatamente o que um endpoint retorna. O usuário recebe essas linhas e nada mais sobre como elas foram produzidas, e você nunca precisa executar um servidor de API, porque o agente que você já possui executa a consulta e o api.querystreams.com cuida do HTTP.

O que você vai precisar

Uma conta do Query Streams

Todos os planos incluem a API REST. O plano gratuito oferece um endpoint, duas chaves e 250 linhas por chamada, o suficiente para criar este guia. Cadastre-se em my.querystreams.com.

O agente em um computador que pode acessar seu próprio banco de dados, com a conexão adicionada.

Geralmente, trata-se do próprio servidor de banco de dados ou de um computador que permanece sempre ligado na mesma rede.

Uma consulta salva no Construtor de Consultas

O endpoint encapsula exatamente uma consulta salva. Escreva o SELECT, execute-o uma vez e salve-o. Adicione um filtro dinâmico (um @variable (na cláusula WHERE) se os chamadores devem poder filtrar.

Configure em quatro etapas

1. Salvar consulta

   Em Construtor de consultas Escolha uma conexão, escreva o comando SELECT e execute-o uma vez. @variable na cláusula WHERE torna-se um parâmetro da API:

   Consulta salva · com um filtro dinâmico

   SELECIONAR ID do cliente, nome, cidade
   DE clientes
   ONDE cidade = @cidade
   ORDEM POR nome;

   Clique em Salvar; o nome passa a ser o nome de exibição do ponto de extremidade.

2. Crie o endpoint

   Aberto API Na barra superior, clique Novo ponto finale em Selecione a consulta Clique na consulta que você salvou. Clique Próximo.

   API aberta

3. Configurar e bloquear parâmetros

   Sobre Configurar manter Vida útil Permanente, Modo de resposta Estático e Formato interno JSON para um primeiro ponto de extremidade; o modo e o formato são fixos após a criação. Parâmetros de bloqueio deixar cidade como Invocável, ou Bloquear Defina-o para um valor fixo que o chamador não possa alterar. Clique. Próximo.

4. Compartilhe e ganhe sua chave.

   Convidar Pessoas por e-mail, adicione um Chave de serviço para uma ferramenta, ou ignore por enquanto e depois clique Criar e obter minha chaveCopie a chave de 49 caracteres que começa com qsapi_; poderá ser revelado novamente mais tarde a partir do Compartilhamento guia. Clique Enviar no console para fazer a primeira chamada.

Ligue de qualquer lugar

Substitua o ID do endpoint pelo seu e qsapi_SUA_CHAVE com a sua chave:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?city=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  "colunas": [ { "nome": "id_do_cliente", "tipo": "inteiro" }, { "nome": "nome", "tipo": "corda" }, { "nome": "cidade", "tipo": "corda" } ],
  "fileiras": [
    { "id_do_cliente": 1042, "nome": "Comerciantes do Vento Norte", "cidade": "Seattle" },
    { "id_do_cliente": 1057, "nome": "Alpine Outfitters", "cidade": "Denver" },
    { "id_do_cliente": 1063, "nome": "Alimentos do Porto", "cidade": "Halifax" }
  ],
  "meta": { "contagem_de_linhas": 3, "duração_do_agente_ms": 41, "id_da_solicitação": "req_7Hq2mKd9" }
}

As linhas retornam como objetos indexados pelo nome da coluna, com a lista de colunas e um meta Bloco que informa quantas linhas existem, se o resultado foi truncado e o ID da solicitação que você pode citar para suporte. A mesma chamada que um POST coloca os parâmetros em um corpo JSON, que é a escolha certa para longas listas de valores:

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"city": "Seattle"}}'

?formato=csv

CSV em vez de JSON, com linha de cabeçalho incluída. Aceitar: texto/csv faz o mesmo. Os endpoints de streaming retornam NDJSON (um objeto JSON por linha) com um final {"_summary": true, "row_count": N} linha; verifique essa última linha.

?sample=true

No máximo cinco linhas, sem cobrança. Ideal para conectar os cabos de um cliente.

?compressão=lz4

Um corpo de estrutura LZ4 para chamadas de alto volume com decodificador; o Código A aba contém o trecho de código decodificador para cada idioma. A compressão gzip simples ocorre automaticamente quando seu cliente envia o arquivo. Codificação aceita: gzip.

Autorização: Portador qsapi_…

Aceito como um pseudônimo para Chave X-APIUse-o a partir do código do navegador.

Onde ele se conecta

Guias por conector

Todos os conectores compatíveis com o Query Streams podem ser publicados desta forma. Escolha o seu:

Bancos de dados que você executa

• Microsoft SQL Server
• PostgreSQL
• MySQL
• MariaDB
• Oráculo
• SQLite
• Microsoft Access
• DuckDB
• Supabase

Armazéns de dados

• Floco de neve
• Google BigQuery

Bancos de dados hospedados

• Néon
• Amazon RDS
• Banco de Dados do Azure para PostgreSQL
• Banco de Dados do Azure para MySQL
• Azure SQL
• Google Cloud SQL
• Google AlloyDB
• Bancos de dados gerenciados da DigitalOcean
• Aiven
• Ponte Crocante
• Heroku Postgres
• Render
• Ferrovia
• Fly.io Postgres
• Bancos de dados gerenciados da Vultr
• Bancos de dados gerenciados da OVHcloud
• Bancos de dados gerenciados da Scaleway
• Banco de dados OCI com PostgreSQL
• Onda de calor MySQL
• Bancos de dados IBM Cloud para PostgreSQL
• MariaDB SkySQL
• Xata
• Nuvem de escala de tempo
• PlanetScale Postgres
• Prisma Postgres
• Koyeb
• Nilo

Pastas de arquivos e registros

• Sistema de arquivos
• Pasta CSV
• Pasta Parquet
• Pasta do Excel
• Pasta SQLite
• Pasta JSONL
• CSV com vários registros
• Registros de máquinas
• Registros do servidor web
• Registros do contêiner
• Registros de aplicativos
• Registros do sistema
• Registros personalizados

Conectores SaaS e API

• Listrado
• Shopify
• HubSpot
• Anúncios do Google
• Google Analytics 4
• Console de pesquisa do Google
• ShipStation
• iTick

Guias para o consumidor: Power BI e Excel via Power Query M.

O que os planos permitem

Cada chamada também possui um tempo limite fixo de consulta de 60 segundos e um limite de resposta de 8 MiB, e os bytes retornados são contabilizados na sua franquia de dados mensal, a mesma franquia usada pelos suplementos do Excel e do Google Sheets. O plano gratuito inclui um endpoint e 5 MB por mês, o que é suficiente para uma pequena tabela acessada várias vezes ao dia. Consulte a página de preços. para as verbas previstas no plano.

Mantendo-o seguro

Quando algo não funciona

Cada corpo de erro tem a forma {"erro": {"código": "…", "mensagem": "…"}} e cada resposta carrega um X-QS-Request-Id Ao entrar em contato com o suporte, mencione o ID no cabeçalho.

Perguntas que as pessoas fazem

Guias relacionados

• API REST do Power BI: conecte-se a dados SQL em tempo real sem drivers ODBC.
• Conecte fluxos de consulta ao Claude via MCP.
• Compartilhe dados em tempo real, não credenciais
• Visão geral dos recursos da API REST do banco de dados