​
Primeiros passos com DataSnap

Este guia mostrará como usar o DataSnap em três etapas simples: fazer upload de dados, processá-los e realizar consultas.

​
Pré-requisitos

Antes de iniciar, você precisa ter:

​
1. Conta na DataSnap

Você precisa ter uma conta ativa na plataforma DataSnap. Se ainda não possui uma, cadastre-se aqui.

​
2. Token de Acesso

Um token de autenticação Bearer válido para acessar e usar todos os endpoints da API DataSnap. Este token funciona como sua “chave de acesso” pessoal e deve ser incluído no cabeçalho Authorization de todas as requisições à API. Como obter seu token:
  1. Acesse o painel de controle da DataSnap
  2. Navegue até a seção “API” ou “Tokens de Acesso”
  3. Clique em “Gerar Novo Token” ou “Criar Token”
  4. Copie o token gerado e mantenha-o seguro
Importante: Mantenha seu token seguro e nunca o compartilhe. Se comprometido, gere um novo token imediatamente no painel de controle.

​
3. Modelo de Dados (Schema) Criado

Você precisa ter um schema criado na plataforma, onde você declara campo a campo que será enviado no arquivo JSONL.
Criação automática de schema: Você também pode enviar um arquivo JSON de exemplo que o sistema vai automaticamente identificar os campos enviados e criar a estrutura de forma automática em 1 segundo!
Como criar um schema: Acesse o painel de controle da DataSnap, vá em “Modelos de Dados” → “Novo Modelo de Dados” e defina a estrutura dos seus dados ou faça upload de um arquivo JSON de exemplo para criação automática.

​
Passo 1: Upload de Arquivos

Comece fazendo upload dos seus dados no formato JSONL para um schema.

​
Preparando seus dados

Seus arquivos devem estar no formato JSONL (JSON Lines), onde cada linha contém um objeto JSON válido: 
{"nome": "João Silva", "idade": 30, "cidade": "São Paulo"}
{"nome": "Maria Santos", "idade": 25, "cidade": "Rio de Janeiro"}
{"nome": "Carlos Oliveira", "idade": 35, "cidade": "Belo Horizonte"}

​
Fazendo o upload

curl -X POST \
  "https://api.datasnap.com.br/api/v1/schemas/meu-schema/files" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -F "files=@dados.jsonl"

​
Verificando o upload

Após o upload, você receberá uma resposta indicando o status de cada arquivo: 
{
  "uploaded": [
    {
      "id": 123,
      "file_name": "dados.jsonl",
      "size_bytes": 1048576,
      "validation": "ok",
      "upload_status": "pending"
    }
  ],
  "success": true
}

​
Passo 2: Processamento

Após o upload, processe seus arquivos para prepará-los para consultas. 
curl -X POST \
  "https://api.datasnap.com.br/api/v1/schemas/meu-schema/process-files" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

​
Resposta do processamento

O sistema retornará informações sobre o processamento iniciado: 
{
  "ids": [1001, 1002],
  "status": "started",
  "schema": "meu-schema",
  "files_count": 1,
  "total_size_mb": 1.0
}
O processamento pode levar alguns minutos dependendo do tamanho dos seus dados. Você pode verificar o status através do endpoint de listagem de arquivos.

​
Passo 3: Consultas

Após o processamento, você pode realizar consultas nos seus dados.

​
Consulta simples

curl -X POST \
  "https://api.datasnap.com.br/api/v1/schemas/meu-schema/query" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json" \
  -d '{
    "select": ["nome", "idade", "cidade"],
    "where": [
      {"field": "idade", "op": ">", "value": 25}
    ],
    "order_by": [
      {"field": "idade", "direction": "desc"}
    ],
    "limit": 10
  }'

​
Consulta com agregação

Você também pode realizar consultas mais complexas com agrupamentos e funções de agregação: 
{
  "select": ["cidade", "count(*) as total", "avg(idade) as idade_media"],
  "group_by": ["cidade"],
  "order_by": [
    {"field": "total", "direction": "desc"}
  ],
  "limit": 5
}

​
Próximos passos

Agora que você conhece o fluxo básico, explore recursos mais avançados:

Gerenciar arquivos

Aprenda a listar, filtrar e gerenciar seus arquivos enviados.

Consultas avançadas

Domine filtros complexos, paginação e formatos de resposta.

Desenvolvimento

Boas práticas para integrar o DataSnap em suas aplicações.

API Completa

Explore toda a documentação da API com exemplos detalhados.
Precisa de ajuda? Entre em contato com nosso suporte ou acesse nossa central de ajuda.