Para obter acesso à API do Ploomes, são necessários dois passos:
Passo 1: gerar um usuário de integração
Passo 2: acessar a coleção com exemplos de chamadas da API

________________________________________________

1) Criação do usuário de integração

Para obter acesso à API do Ploomes, é necessário que haja pelo menos um usuário de integração na sua conta. Este usuário não tem custo adicional e também não é possível acessar o sistema através dele. Ele é destinado exclusivamente para o desenvolvimento de automações e integrações.

Para criar um usuário de integração, o primeiro passo é acessar sua conta e clicar em Administração. Na tela que se abrir, clique em Usuários de Integração.

Na aba que se abrir, clique em Novo usuário no canto superior direito. Preencha as informações a seguir: Nome, E-mail* e Perfil.

Observações:

  1. O e-mail precisa ser um e-mail em um padrão válido, exemplo: "automacao@suaempresa.com". Ele não precisa existir de fato, já que não permitirá acesso à conta, mas precisa estar nos padrões de endereços de e-mail reais.
  2. O perfil do usuário de integração funciona assim como de um usuário normal. Este usuário terá acesso aos dados que um usuário normal teria. Geralmente usamos o perfil de Administrador para que o usuário de integração tenha permissão para manipular todos os dados da conta, mas isso pode ser alterado de acordo com a necessidade.

Depois de criado, o novo usuário aparecerá na lista, e ao clicar em seu nome, é possível ver a chave de integração gerada, como mostrado a seguir:

É esta chave que será usada nas requisições da API.

**Obs: Note que o usuário recém criado não aparece na mesma lista que os demais usuários.

________________________________________________

2) Acesso à coleção do Postman

A Ploomes disponibiliza todos os casos de teste necessários em forma de coleção do Postman, que é um Plugin do navegador Chrome cuja finalidade é tornar o acesso a APIs mais fácil. É possível acessar esta coleção através do seguinte link:

https://www.getpostman.com/collections/97e9e773223690f536d9

Todas as chamadas iniciam com {{server}} e possuem um Header User-Key {{uk}}. Estas são as variáveis do Postman que utilizamos para desenvolvimento. Substitua-as da seguinte maneira:

{{server}}:  https://api2.ploomes.com/

{{uk}}:  chave de usuário gerada no passo 1

Nossa API está desenvolvida com base no OData v4, um protocolo de consumo de dados (http://www.odata.org/documentation/). A parte mais útil para entender a sintaxe está aqui: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html

________________________________________________

Pronto, agora é possível utilizar a API do Ploomes para automatizar ainda mais processos e integrar softwares a fim de otimizar o tempo de sua equipe comercial para que foquem no que realmente importa: vender mais!

Encontrou sua resposta?