Documentação
API
- O QUE É A REST API?
-
A API permite ler e escrever dados no ERP.
Para informações técnicas consulte a página de exemplos:
Na página de exemplos pode encontrar código fonte para invocar a API.Além disso também pode fazer download do código fonte apresentado e utiliza-lo nos seus testes ou como ponto inicial de desenvolvimento do seu sistema.
Os exemplos apresentados incluem:
Clientes
Documentos
Produtos
Outros
- COMO POSSO INVOCAR A API?
-
A API pode ser invocada a partir de qualquer sistema em qualquer linguagem de programação.
Pode aceder à REST API através do endereço:
A REST API permite:
- Testar invocações à API
- Identificar as operações de leitura e escrita disponíveis na API
- Identificar os parâmetros de entrada de cada operação
- Identificar os códigos de resposta de cada operações e o seu significado
- Identificar as propriedades cada modelo (account, document, produdct, etc)
Para invocar a API necessita de autenticar-se com uma API KEY e COMPANY KEY válidas.Contacte-nos para obter a sua API KEY e COMPANY KEY.
Na REST API pressionar o botão "Authorize" e de seguida:- Introduzir API KEY e pressionar no respectivo botão authorize.
- Introduzir COMPANY KEY e pressionar no respectivo botão authorize.
- A QUEM SE DESTINA A API?
-
A API destina-se a programadores que pretendam ler ou escrever dados no sistema ERP.
- PORQUÊ O FORMATO OPEN API?
-
A Iniciativa OpenAPI (OAI) foi criada por um consórcio de especialistas do setor voltados para o futuro que reconhecem o imenso valor da padronização de como as APIs REST são descritas. Como uma estrutura de governança aberta sob a Linux Foundation, a OAI está focada na criação, evolução e promoção de um formato de descrição neutra do fornecedor. O SmartBear Software está doando a Especificação do Swagger diretamente para o OAI como base desta Especificação Aberta.
As APIs formam a ligação de conexão entre aplicativos modernos. Quase todos os aplicativos usam APIs para se conectar a fontes de dados corporativas, serviços de dados de terceiros ou outros aplicativos. Criar um formato de descrição aberto para serviços de API que seja neutro, portátil e aberto para o fornecedor é fundamental para acelerar a visão de um mundo verdadeiramente conectado.
Mais informação: Homepage
Mais informação: About
- DESENVOLVIMENTO EM JAVASCRIPT
-
Para desenvolver em Javascript deve fazer pedidos AJAX ao servidor no formato JSON.
Recomendamos o uso de uma biblioteca como o jQuery ou o Angular.
Para informações técnicas consulte a página de exemplos: - DESENVOLVIMENTO EM PHP
-
A livraria para desenvolvimento de projetos em PHP é disponibilizada como pacote através do Packagist.
O pacote está publicado no seguinte endereço:
https://packagist.org/packages/e2e/e2e-sdk-php
O Packagist é um repositório de pacotes PHP.
Os pacotes são livrarias com uma determinada funcionalidade bem identificada e que podem ser adicionados a um projeto.
Mais informação: https://packagist.org/
O Composer é uma ferramenta que lê pacotes do repositório Packagist.
O Composer faz o donwload de pacotes do repositório Packagist onde o pacote do E2E.pt está publicado.
Mais informação: https://getcomposer.org/
Para informações técnicas consulte a página de exemplos: - DESENVOLVIMENTO EM JAVA
-
Livraria para desenvolvimento de projetos em Java.
Para informações técnicas consulte a página de exemplos: - DESENVOLVIMENTO EM C#
-
Livraria para desenvolvimento de projetos em C#.
Para informações técnicas consulte a página de exemplos:
