XD Soba Documentation - API Documentation

Gerenciamento de Entidades

API abrangente para gerenciar clientes, fornecedores e entidades comerciais. Crie, atualize e acompanhe relacionamentos entre diferentes entidades em seu ecossistema de negócios.

Operações Comerciais

Gerencie operações comerciais principais, incluindo contas de verificação manual, documentos de recebimento e gestão do tesouro. Otimize seus fluxos de trabalho financeiros e operacionais.

Integração de Pagamento

Processamento de pagamento perfeito com integração XDPay. Gerencie transações, processe pagamentos e opere financeiramente com segurança.

Gerenciamento de Relatórios

API para geração e gerenciamento de relatórios. Suporta tanto relatórios pré-definidos padrão quanto relatórios personalizados dinâmicos. Recupere dados de relatórios, aplique filtros, salve configurações, etc...

Gerenciamento de Mesas

API para gerenciar mesas, recuperar resumos e detalhes e gerenciar pedidos de itens. Recupere zonas de mesas disponíveis, liste mesas por zona, adicione itens ao carrinho e gerencie cancelamentos de forma eficiente.

Autenticação e Segurança

Sistema robusto de autenticação com controle de acesso baseado em funções. Proteja seus endpoints de API e dados comerciais sensíveis.

Gerenciamento de Configuração

Sistema flexível de configuração para personalizar suas regras e configurações de negócio. Adapte o sistema às suas necessidades comerciais específicas.

Arquitetura de Microsserviços

Construído em uma arquitetura escalável de microsserviços. Serviços separados para cliente web, gateway de API, relatórios e funcionalidade principal garantem desempenho ideal.

Sobre a API XD Soba

A API XD Soba fornece uma interface robusta para gerenciar suas operações de negócio. Construída com princípios REST modernos, oferece uma maneira segura, escalável e amigável para desenvolvedores de se integrar com a plataforma XD Soba.

Principais Recursos

Gerenciamento de Entidades - Crie e gerencie clientes, fornecedores e outras entidades comerciais
Controle de Região de Entrega - Defina e gerencie regiões de entrega com limites precisos
Gerenciamento de Itens e Grupos - Organize itens em grupos e gerencie-os com eficiência
Gerenciamento de Relatórios - Acesse relatórios padrão e dinâmicos com parâmetros flexíveis e opção de exportação
Gerenciamento de Mesas - Gerencie mesas e suas respectivas zonas de forma eficiente
Autenticação Segura - Autenticação baseada em JWT com controle de acesso baseado em funções
Documentação Abrangente - Referência detalhada da API com exemplos e guias

Primeiros Passos

Para começar a usar a API XD Soba, você precisará:

Obter suas credenciais de API na plataforma XD Soba
Revisar o Guia de Primeiros Passos
Explorar a Referência da API
Confira o Guia de Uso da API para melhores práticas

Capacidades da API

Gerenciamento de Entidades

Criar e atualizar perfis de clientes
Gerenciar informações de fornecedores
Acompanhar relacionamentos entre entidades
Gerenciar atualizações de status de entidades

Operações de Entrega

Definir regiões de entrega
Estabelecer limites de entrega
Gerenciar horários de entrega
Acompanhar status de entrega

Gerenciamento de Itens

Criar e atualizar itens
Organizar itens em grupos
Gerenciar inventário de itens
Acompanhar status de itens

Segurança e Acesso

Autenticação baseada em JWT
Controle de acesso baseado em funções
Gerenciamento de chaves de API
Transmissão segura de dados

Gerenciamento de Mesas

Gerencie mesas, recupere resumos e detalhes e gerencie pedidos de itens.
Recupere zonas de mesas disponíveis
Liste mesas por zona
Adicione itens ao carrinho
Gerencie cancelamentos de forma eficiente
Envie os itens do carrinho para a mesa específica.

Gerenciamento de Relatórios

Visualize relatórios sobre vendas, compras, contas correntes, etc., garantindo uma gestão e análise eficaz do seu negócio.
Crie relatórios personalizados dinâmicos
Aplique filtros e parâmetros flexíveis
Salve configurações personalizadas
Exporte relatórios dinâmicos

Começar a Construir →