Atenção: o REST Framework é uma funcionalidade experimental que ainda está em desenvolvimento, portanto podem ocorrer mudanças significativas na API. É recomendado que este framework seja utilizado apenas com orientação da Bematech.


No Engine foi desenvolvido um framework para disponibilizar de forma simples os dados do ERP por meio de uma API REST. Esse framework permite o acesso aos dados do ERP a partir de outro sistemas ou interfaces web, por meio uma API de fácil consumo por outras tecnologias.

A base do REST Framework são: uma API que permite a manipulação das entidades das classes de dados, a definição de rotas e os controladores responsáveis por tratar as requisições. O desenvolvedor que precisar criar recursos REST para o Bematech ERP trabalhará basicamente sobre esses componentes para dispor informações ou recebê-las de outros sistemas.

O REST Framework utiliza as definições de modelo de dados e regras de negócios declaradas por meio de arquivos de definições de modelo de dados (x-model). Por meio desses arquivos, a API do Framework REST possui acesso a todas as regras de negócio definidas para as classes de dados, como regras de preenchimento de campos, validações gerais e regras definidas em eventos do sistema, que serão executados por ele durante o consumo de um recurso que utilize a API de manipulação das entidades das classes de dados.

Esse modelo de definições via arquivos x-model é compartilhado pelo REST Framework e pelo Web Framework, garantindo que as regras associadas as classes de dados definidas em um único local sejam respeitadas em qualquer cenário de uso, seja em uma manipulação de dados realizada por um outro sistema via uma API HTTP, seja por um usuário do sistema alterando uma grade do Web Framework.

Para acessar e alterar os dados do sistema, consulte a documentação das APIs HTTP disponibilizadas pelo sistema:
Para desenvolver novas APIs HTTP utilizando o Framework REST, será disponibilizado em breve o manual de desenvolvimento do Framework REST.
documentação
   manuais
    
perguntas frequentes

atualizações

  • 2016.12 Defeitos Corrigidos Ao enviar as credenciais do usuário para uma API HTTP utilizando um token de autorização ocorria o erro "O caminho XXXX requer autorização do usuário e as credenciais ...
    Postado em 22 de dez de 2016 04:56 por Mateus Leon
  • 2016.11 Publicação Técnica Foi alterada a funcionalidade Servidor HTTP do Engine com a finalidade de tornar o tratamento de requisições ou respostas com conteúdo do tipo application/json mais aderente à ...
    Postado em 22 de nov de 2016 10:56 por Mateus Leon
Exibindo postagens 1 - 2 de 7. Exibir mais »