Documentação XD Soba
API Poderosa para gerir o seu negócio usando o ecossistema XD
Gestão de Entidades
API abrangente para gerir clientes, fornecedores e entidades comerciais. Crie, atualize e acompanhe relacionamentos entre diferentes entidades no seu ecossistema de negócios.
Operações Comerciais
Faça a gestão de 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 pagamentos integrado/fluido com integração XDPay. Faça a gestão de transações, processe pagamentos e opere financeiramente com segurança.
Gestão de Relatórios
API para geração e gestão 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.
Gestão de Mesas
API para gerir mesas, obter resumos e detalhes e gerir pedidos de artigos. Obtenha zonas de mesas disponíveis, liste mesas por zona, adicione artigos ao carrinho e faça a gestão de 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.
Gestão de Configuração
Sistema flexível de configuração para personalizar as 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 gerir as suas operações de negócio. Construída com princípios REST modernos, oferece uma forma segura, escalável e acessível para programadores se integrarem com a plataforma XD Soba.
Principais Recursos
- Gestão de Entidades - Crie e faça a gestão de clientes, fornecedores e outras entidades comerciais
- Controle de Região de Entrega - Defina e faça a gestão de regiões de entrega com limites precisos
- Gestão de Artigos e Famílias - Organize artigos em famílias e faça a sua gestão com eficiência
- Gestão de Relatórios - Aceda a relatórios padrão e dinâmicos com parâmetros flexíveis e opção de exportação
- Gestão de Mesas - Faça a gestão de mesas e das 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 as suas credenciais de API na plataforma XD Soba
- Revisar o Guia de Primeiros Passos
- Explorar a Referência da API
- Consulte o Guia de Uso da API para melhores práticas
Capacidades da API
Gestão de Entidades
- Criar e atualizar perfis de clientes
- Gerir informações de fornecedores
- Acompanhar relacionamentos entre entidades
- Gerir atualizações de estado de entidades
Operações de Entrega
- Definir regiões de entrega
- Estabelecer limites de entrega
- Gerir horários de entrega
- Acompanhar estado de entrega
Gestão de Artigos
- Criar e atualizar artigos
- Organizar artigos em famílias
- Gerir inventário de artigos
- Acompanhar estado de artigos
Segurança e Acesso
- Autenticação baseada em JWT
- Controle de acesso baseado em funções
- Gestão de chaves de API
- Transmissão segura de dados
Gestão de Mesas
- Faça a gestão de mesas, recupere resumos e detalhes e faça a gestão de pedidos de artigos.
- Recupere zonas de mesas disponíveis
- Liste mesas por zona
- Adicione artigos ao carrinho
- Faça a gestão de cancelamentos de forma eficiente
- Envie os artigos do carrinho para a mesa específica.
Gestão 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