A API do Ploomes permite integrar o CRM com outros sistemas, automatizar processos e manipular dados da conta por meio de requisições externas.
Para começar a utilizar a API, é necessário realizar duas etapas:
Criar um usuário de integração, responsável por gerar a chave de acesso utilizada nas requisições.
Utilizar a coleção de exemplos da API, disponível para testes e desenvolvimento.
Você pode consultar a documentação completa da API neste link: https://developers.ploomes.com/
Criar um usuário de integração
Para acessar a API do Ploomes, é necessário que exista pelo menos um usuário de integração na conta.
Esse tipo de usuário:
não possui custo adicional
não pode acessar o sistema
é utilizado exclusivamente para integrações e automatizações
Como criar
Acesse Administração no menu do sistema.
Clique em Usuários de integração.
Clique em Novo usuário no canto superior direito.
Preencha o nome, e-mail¹, perfil² e outras informações obrigatórias do formulário
Clique em Criar usuário.
Após a criação, o usuário aparecerá na lista³. Ao clicar sobre ele, será exibida a chave de integração (User-Key), que deverá ser utilizada nas requisições da API.
Observações:
O e-mail informado precisa seguir um formato válido (por exemplo:
automacao@suaempresa.com). Esse endereço não precisa existir de fato, pois o usuário de integração não permite login no sistema.
O e-mail é um dado único, então não pode ser igual ao de um usuário existente na conta ou no Ploomes em geral.O perfil funciona da mesma forma que para usuários comuns, definindo quais dados a integração poderá acessar ou modificar.
Na maioria dos casos, recomenda-se utilizar o perfil de Administrador, pois ele possui acesso completo aos dados da conta. No entanto, o perfil pode ser ajustado conforme a necessidade da integração.
Usuários de integração não aparecem na mesma lista que os usuários comuns. Eles ficam disponíveis apenas na área de Usuários de integração em Administração.
Utilizar a coleção de testes da API
A Ploomes disponibiliza uma coleção de exemplos de chamadas da API, que pode ser utilizada para realizar testes e facilitar o desenvolvimento de integrações.
Essa coleção pode ser utilizada no Postman, uma ferramenta bastante comum para testes de APIs.
Acesse o arquivo da coleção por este link.
No arquivo da coleção, todas as chamadas utilizam duas variáveis:
{{server}}{{uk}}
Elas devem ser substituídas da seguinte forma:
#{{server}}: https://public-api2.ploomes.com/
#{{uk}}: chave de usuário gerada na criação do usuário de integração.
Essa chave deve ser enviada no Header da requisição com o parâmetro: User-Key
Estrutura da API
A API do Ploomes é baseada no protocolo OData v4, que define padrões para consulta e manipulação de dados via HTTP.
Esse protocolo permite realizar operações como:
filtros
ordenação
paginação
seleção de campos
Para entender melhor a sintaxe das requisições, consulte a documentação oficial do OData: https://www.odata.org/documentation/
Também recomendamos a leitura das convenções de URL do protocolo: http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part2-url-conventions.html
Leia também:
Acesse a Universidade Ploomes para saber mais
A Ploomes disponibiliza uma plataforma de educação digital criada para capacitar seus clientes, oferecendo uma variedade de cursos, shorts e casos de uso.
Abaixo, você confere sugestões de conteúdos disponíveis em nossa plataforma que se relacionam ao tema deste artigo.
Esse artigo te ajudou? Deixe seu retorno abaixo para continuarmos sempre melhorando nossa base de conhecimento. 😊
Ficou com alguma dúvida? Não hesite em chamar o Suporte pelo chat da plataforma ou pelo e-mail suporte@ploomes.com.