Autenticação da API

As APIs da Plataforma de e-Commerce TMWxD foram desenvolvidas de uma forma a simplificar o máximo possível a integração com sua loja virtual a partir de qualquer outro sistema, como ERPs, por exemplo.

O acesso é feito pelo método RESTful com autenticação Basic Access Authentication. O usuário e senha de acesso podem ser pegos na sua plataforma, como explicado abaixo.

A url de acesso será sempre https://www. sua-loja.com.br /tmwxdapi/ recurso

Os recursos do tipo POST deverão ter seus dados de alteração/criação enviados através do BODY da requisição, em formato JSON.

Se tudo ocorrer bem, o campo status terá o valor true e o header da requisição poderá ser:
200 - GET
201 - POST
Dados da API

Os dados de acesso, bem como os recursos disponíveis, podem ser pegos através do campo Chave de Acesso da API, na seção SEO em Configurações Gerais.

Se alterar o valor desse campo (que pode ser qualquer um, sem espaço nem caracteres especiais), os dados de acesso serão alterados. Isso é importante para quando você quer impedir o acesso à API de sua loja por parte de desenvolvedores que não trabalham mais para você.

Uma vez que haja algum valor no campo Chave de Acesso da API, e você tenha salvo as alterações, aparecerá o ícone "..." (Opções da API). Clicando nele, você verá os dados de acesso Basic Auth para sua API.

Caso haja erros, isso será indicado tanto pelo header da requisição como pelo campo status do retorno, que terá o valor false, como o do exemplo a seguir (neste exemplo, o header da requisição será 401):

    {
        "status": false,
        "code": 0,
        "message": "Dados de autorização inválidos."
    }
Em caso de falha o campo status terá o valor false e o header poderá ser:
400 - Dados Inválidos
401 - Não autorizado
404 - Recurso inexistente ou não homologado
500 - Erro fatal

O code poderá ser 0 (não processado) ou 1 (processado, porém com falhas). Quando code tiver um conteúdo diferente destes, trata-se de um erro interno. Favor copiar seu conteúdo e nos enviar para análise.

Os recursos do tipo GET retornam no máximo 50 itens. Use os filtros de paginação para visualizar mais itens.

Atualização de Produtos

ERP envia estoque e valores

setProducts

TMWxD valida os dados e informa ao ERP se houve sucesso

ERP trata a resposta e finaliza.


Tratamento de Pedidos

ERP solicita novos pedidos

getOrders

TMWxD envia os dados solicitados

ERP solicita as informações dos produtos e do cliente de cada pedido

getProducts e getClients

TMWxD envia os dados solicitados

ERP faz a baixa no seu estoque baseado nos dados dos produtos do pedido e gera a NF. Então, envia os dados da NF gerada para o pedido.

setOrder

TMWxD trata os dados e, se tudo estiver correto, altera o pedido conforme dados enviados, devolvendo resultado ao ERP

ERP trata a resposta e finaliza.