API

- Fev 01

A Interface de Programação de Aplicações (API) da Scanlily permite que os assinantes do plano Negócios integrem seus dados de inventário com sistemas externos, automatizem fluxos de trabalho e criem aplicações personalizadas que funcionem perfeitamente com a Scanlily.

a. O que é a API da Scanlily?

A API fornece acesso programático e seguro aos seus dados de inventário da Scanlily. Em vez de inserir dados manualmente através do aplicativo ou da interface web, você pode usar a API para sincronizar automaticamente informações entre a Scanlily e seus outros sistemas de negócios. Isso cria um ecossistema de gestão de inventário unificado onde todas as suas ferramentas trabalham juntas.

b. Endpoints Disponíveis

A API da Scanlily fornece três endpoints:

GET /getitems - Recupera itens de inventário com filtros opcionais (por código de barras, categoria, local, etc.)

POST /updateitem - Atualiza a quantidade e/ou o preço dos itens existentes

POST /createitem - Cria novos itens de inventário com suporte total aos campos

c. Casos de Uso Comuns

As organizações usam a API da Scanlily de várias maneiras:

Sincronização de Inventário

  • Sincroniza os níveis de inventário entre a Scanlily e sua plataforma de e-commerce
  • Atualiza as quantidades automaticamente quando as vendas ocorrem em seu sistema de PDV
  • Importa dados de produtos de catálogos de fornecedores ou sistemas ERP

Relatórios e Análises Personalizadas

  • Extrai dados de inventário para ferramentas de business intelligence
  • Cria painéis personalizados que combinam dados da Scanlily com outras métricas
  • Gera relatórios especializados não disponíveis na interface padrão

Automação de Fluxo de Trabalho

  • Atualiza automaticamente as informações do item com base em gatilhos externos
  • Cria alertas em outros sistemas quando os níveis de inventário mudam
  • Integra com software de contabilidade para rastreamento de ativos

Aplicações Móveis e Personalizadas

  • Cria aplicativos móveis especializados para casos de uso específicos
  • Cria interfaces simplificadas para grupos de usuários específicos
  • Desenvolve sistemas de quiosque ou exibição mostrando o inventário em tempo real
d. Como Funciona

A API usa princípios REST padrão da indústria e retorna dados em formato JSON, tornando-a compatível com praticamente qualquer linguagem de programação ou plataforma. As principais características incluem:

  • Autenticação Segura: Cada assinante do plano Negócios recebe uma chave de API exclusiva para garantir a segurança dos dados
  • Consultas Flexíveis: Recupera itens por vários critérios, incluindo código de barras, local, categoria ou filtros personalizados
  • Atualizações em Tempo Real: As alterações feitas através da API aparecem imediatamente no aplicativo Scanlily e na interface web
  • Limitação de Taxa: Proteções integradas garantem a estabilidade do sistema, permitindo operações de alto volume

Por exemplo, você pode usar o endpoint /getitems para recuperar todos os itens em um local específico, o endpoint /updateitem para ajustar as quantidades após uma contagem de estoque ou o endpoint /createitem para adicionar novos itens de um sistema externo.

e. Começando com a API

Para começar a usar a API da Scanlily:

  1. Entre em Contato com o Suporte da Scanlily - Os assinantes do plano Negócios podem solicitar acesso à API e receber suas credenciais de desenvolvimento
  2. Acesse o Sistema de Desenvolvimento - Teste sua integração com segurança em nosso ambiente de desenvolvimento em s2.scanlily.com
  3. Crie Dados de Teste - Use o aplicativo Scanlily Development para configurar um inventário de amostra que espelhe suas necessidades de produção
  4. Construa Sua Integração - Use nossa documentação abrangente e código de exemplo para criar sua solução personalizada
  5. Mova para a Produção - Uma vez testado, receba credenciais de produção para trabalhar com seus dados ativos
f. Recursos de Desenvolvimento

Fornecemos amplos recursos para ajudá-lo a ter sucesso:

  • Documentação detalhada da API com todos os endpoints e parâmetros disponíveis
  • Código de exemplo em Python e JavaScript
  • Respostas JSON de amostra mostrando formatos de dados exatos
  • Ferramentas de teste para validar sua integração

A documentação da API inclui especificações técnicas completas, detalhes de autenticação e exemplos práticos. Seja você um desenvolvedor construindo uma integração personalizada ou trabalhando com um parceiro técnico, você encontrará tudo o que precisa para conectar a Scanlily com seus sistemas de negócios.

g. Requisitos

O acesso à API está disponível exclusivamente para assinantes do nível Negócios. A API respeita todas as permissões de usuário e controles de acesso configurados em sua conta Scanlily, garantindo a segurança dos dados e a conformidade com as políticas organizacionais.

Para documentação técnica completa, código de exemplo e detalhes de implementação, consulte a Documentação da API da Scanlily.

Para solicitar acesso à API ou saber mais sobre as possibilidades de integração, entre em contato com o suporte da Scanlily em support@scanlily.com.