Skip to main content

Estrutura da API

A API DataSnap segue uma arquitetura RESTful organizada em torno de schemas de dados, com endpoints claros e intuitivos.
Todos os endpoints seguem o padrão /api/v1/schemas/{slug}/ para operações específicas de schema.

Hierarquia de recursos

Schemas

Os schemas são o ponto central da organização dos dados no DataSnap:

Endpoints principais

Geração de Token de Upload

POST /api/v1/schemas/{slug}/generate-upload-tokenGere URLs pré-assinadas para upload direto

Gerenciamento de Arquivos

GET /api/v1/schemas/{slug}/filesListe e gerencie arquivos enviados

Upload de Arquivos

POST /api/v1/schemas/{slug}/filesEnvie arquivos JSONL para armazenamento

Consultas

POST /api/v1/schemas/{slug}/queryExecute consultas SQL nos dados

Padrões de navegação

Fluxo típico de uso

Siga esta sequência para uma integração completa:
1

1. Gerar Token de Upload

Gere uma URL pré-assinada usando POST /generate-upload-token.
2

2. Upload de Arquivos

Use a URL retornada para fazer upload direto via HTTP PUT.
3

3. Consultas

Execute análises com POST /query nos dados armazenados.

Parâmetros de navegação

Paginação

Todos os endpoints de listagem suportam paginação:

Filtros

Use filtros para navegar eficientemente pelos dados:

Ordenação

Controle a ordem dos resultados:

Status de arquivos

Entenda os diferentes status para navegar adequadamente:

Consultas por status

Consultas complexas

Estruture consultas para navegação eficiente nos dados:

Paginação com cursor

Para grandes volumes de dados, use paginação com cursor:

Códigos de resposta

Entenda os códigos para navegar adequadamente pelos erros:

Códigos de sucesso

  • 200 OK: Operação realizada com sucesso
  • 201 Created: Recurso criado com sucesso

Códigos de erro

  • 400 Bad Request: Parâmetros inválidos
  • 401 Unauthorized: Token inválido ou ausente
  • 404 Not Found: Schema ou recurso não encontrado
  • 422 Unprocessable Entity: Dados inválidos

Boas práticas de navegação

Performance

Monitoramento

Implemente monitoramento para navegação eficiente:

Próximos passos

Guia prático

Siga nosso guia passo a passo

Referência completa

Explore todos os endpoints disponíveis