Utilizar as APIs da plataforma para extrair informações

Utilizar as APIs da plataforma para extrair informações Uma API, do inglês Application Programming Interface, é um programa que permite a duas aplicações distintas comunicarem entre si e trocarem dados. As nossas APIs existem para estabelecer a ligação entre os seus dados existentes na plataforma e qualquer aplicação de terceiros à sua escolha capaz de receber esses dados. As nossas APIs são privadas (enterprise APIs). São seguras e dispõem de uma chave de identificação (access_token), fornecida por um serviço de autenticação e autorização (oauth/token). O nosso protocolo de comunicação baseia-se em REST (Representational State Transfer) de forma a ser compatível com as diversas plataformas móveis, seja uma aplicação Windows, Apple ou Android. Recomendamos a utilização da interface POSTMAN se pretender testar a formulação dos seus pedidos às APIs.

Os dados que pode extrair em GET

CATEGORIAS

• lista de categorias
• detalhes das categorias

PRODUTOS

• lista de produtos
• detalhes dos produtos

CLIENTES

• lista de clientes
• detalhes dos clientes por ID
• detalhes dos clientes por email

PONTOS DE VENDA

• lista de pontos de venda
• detalhes de um ponto de venda por ID
• detalhes das locações por ID de ponto de venda
• detalhes dos stocks por ID de ponto de venda
• detalhes das transações por ID de ponto de venda

LOCAÇÕES

• lista de locações
• detalhes das locações

EXPORTAÇÕES

• exportação dos pagamentos em caixa
• exportação dos pagamentos online

Os dados que pode injetar em POST

• criar um cliente
• criar uma locação

Gerar o seu token em Ferramentas > Chaves API

Clique em Criar credenciais. Escolha o nome a associar às suas credenciais, e clique em GUARDAR no canto inferior direito. O seu ID de cliente e a sua chave secreta serão automaticamente gerados pela plataforma. Uma notificação verde é apresentada no canto superior direito da janela quando as suas chaves foram criadas com sucesso. Copie o seu ID de cliente e a sua chave secreta, pois irá precisar deles na etapa 6 — é este par de credenciais que constitui o seu token.

Aceder às APIs da sua plataforma

Por razões de segurança, o acesso à documentação da API não é possível a partir do BO. Se precisar de utilizar a documentação da API Rental, por favor abra um ticket no suporte para solicitar os seus acessos.

Assim que tiver acesso à sua documentação API, configure o seu access_token através de /openapi/V1/ Clique no botão "AUTHORIZE". E cole o token obtido na pop-in de autorização global que aparece. Substitua o client_ID e o client_secret pré-preenchidos pelas chaves geradas na etapa 4. Está agora autenticado e o seu token será automaticamente enviado para autorizar cada um dos seus pedidos.

Exemplo de chamada à lista de categorias

Abra o menu GET/categories clicando na seta no lado direito e, em seguida, clique em EXECUTE. A resposta da API Category List é apresentada abaixo. Pode, se necessário, transferir a resposta do servidor no formato JSON. Na parte inferior da resposta, clique em DOWNLOAD para transferir o ficheiro.

Formato das respostas

Encontrará o detalhe do formato das respostas, nomeadamente das eventuais respostas em erro, na parte inferior da documentação em "SCHEMAS". Se pretender utilizar o Postman em paralelo, autentique-se igualmente na sua aplicação com o mesmo access token. Opção 1: Autentique-se com um bearer token no header. E por fim teste o pedido. Por exemplo, para a lista de categorias. Atenção: está em vigor um limite de um pedido por segundo de forma a evitar sobrecargas no servidor.

Ao adicionar a sua API, pode ver a sua data de expiração.