Documentação Api ViaShopModa
≡ Menu
Atualizado em 26/10/2023

Introdução

Seja bem-vindo a nossa documentação!

Referência da API

A esquerda estão listados todos os recursos dispníveis e cada um de seus endpoints determinando o que será consumido pela API.
Todas as chamadas precisam ser enviadas com um token de acesso para (fornecido por nós) cliente e encaminhado para o integrador.
Toda a comunicação desta API será representada por objetos JSON.

Chamando a API

Veja como funciona a estrura de URL desta API.

{URL_BASE_API}/via/{RECURSO}/{ENDPOINT}/{TOKEN}

  • {RECURSO}

    Nome do recurso que deseja consumir. Por exemplo: produto, pedido...

  • {ENDPOINT}

    Ação em si que determinará o que será consumido. Por exemplo: atualizar, cadastrar, consultar...

  • {TOKEN}

    Substituir {TOKEN} pelo token único do cliente.

Respostas (responses)

  • 429 Too Many Requests: Seu token de acesso estourou o limite diário de chamadas. Consulte abaixo sobre os limites.
  • 401 Unauthorized: O token utilizado é inválido ou ainda não esta ativo.
  • 400 Bad Request: A solicitação não foi bem sucedida e o item msg_erro será retornado.
  • 200 OK: A solicitação foi realizada, porém o item retorno dirá se deu tudo certo através de um true ou false.

Para todas as duas situações acima o item status será retornado o código da resposta e o msg_alerta poderá ser retornado alertando que a chamada pode ser otimizada de alguma forma.

Limites de Requisições

  • 1 requisição por segundo;
  • 1 mil requisições por dia;
  • 20 registros por requisição para processamento em lote;
  • 20 registros por página em cada consulta, consulte: Paginação de resultados.

Paginação de resultados

Quando uma consulta retornar mais de 20 resultados será criado o item total_registros dentro de cabecalho como no exemplo abaixo:

Este padrão se aplica para qualquer tipo de consulta.

Para acessar as demais páginas basta adicionar o parâmetro ?pagina, por exemplo pagina=2, no GET da requisição.

            {
                "cabecalho": {
                    "paginacao": {
                        "total_registros": 52,
                        "limite_paginas": 20,
                        "total_paginas": 3,
                        "pagina_atual": 1,
                        "ultima_pagina": false
                    }
                },
                "item_solicitado": [...],
            }
  1. total_registros

    Informa o total de registros sua busca possui desconsiderando a paginação.

  2. limtie_paginas

    Limite de registros por página.

  3. total_paginas

    Quantas páginas sua busca obteve.

  4. pagina_atual

    Em qual página está sua consulta.

  5. ultima_pagina

    Informa se a página atual é a ultima página ou não através de um true ou false

Webhook

Usado para que esta API possa se comunicar com seu sistema fornecendo dados em tempo real sempre que um evento acontecer.

Nosso webhook funciona para, por exemplo, te dar informações do extrato das suas vendas, sacola abandonada, além dos dados de leads e cadastros em tempo real, sem que você precise ficar pesquisando por períodos.


Funcionamento
  1. Você nos fornecerá a sua URL.
  2. Sempre que um evento ocorrer na loja virtual, lhe avisaremos em tempo real através de método POST.
  3. Você poderá personalizar como deseja receber os dados: raw:json ou form-data.
  4. Você poderá interpretar os dados já na sua URL de destino, ou capturar os parâmetros GET da URL para efetuar um consulta em nossa API.

    Parâmetros GET
    Adicionamos dois parâmetros à sua URL
    1. endpoint: Trata-se do caminho de volta para poder consumir a mesma informação que foi enviada. Por ex.: endpoint=via/padido/consultar
    2. key=val: Onde 'key' será o parâmetro relativo à busca realizada no webhook e 'val' o seu valor correspondente. Por ex.: pedido=111111.

    Com os dados acima, adicionando o {TOKEN}, é possivel realizar essa mesma consulta de volta na API e obter o mesmo resultado.
    A url base seria: https://{URL_BASE}/{ENDPOINT}/{TOKEN}/?{KEY}={VAL}, que transformando para o exemplo acima ficaria {{URL_BASE}}via/pedido/consultar/{TOKEN}/?pedido=111111

Eventos
Para cada um dos eventos abaixo pode ser cadastrado uma url diferente.
  1. Lead
    - Quando usuário (ainda não cadastrado) manifesta um atendimento e fornece seu nome e whatsapp.
    - Quando usuário cadastra seu e-mail para receber as newsletters.
  2. Cadastro de cliente
    - Quando um novo cadastro se cadastra ou quando a loja inclui um novo cliente.
  3. Pedido
    - Quando um novo pedido é realizado pelo cliente ou pela loja.
  4. Sacola abandonada
    - Quando nossos sistemas identificam a exixtência de produtos na sacola de um cliente que não realizou o pedido.
  5. Estoque
    - Quando um estoque é atualizado manualmente.

Solicitar token de acesso

Solicite aqui o token de acesso a nossa API.

Solicitar Integração

Solicite aqui a integração ao seu sistema.

Suporte

Dúvidas ou suporte entre em contato através do e-mail {{SUPORTE.EMAIL}}.
↑