A API é uma interface para a comunicação entre add-ons de terceiros. Pode integrar o RO App com qualquer add-on, acedendo à base de dados através da API. Para iniciar a integração, é necessário ler a especificação da API e verificar os métodos disponíveis na página Configurações > API.
⭐ Esta funcionalidade está disponível a partir do plano de subscrição Business.
Observação: Se alguns endpoints ainda não estiverem disponíveis na versão mais recente da documentação da API, você pode mudar para a versão anterior. A versão descontinuada da API será suportada até 1º de setembro de 2026.
Tenha em atenção que todas as entradas na API são efectuadas em nome do funcionário utilizando a sua chave API única. Pode encontrar a chave de API de um funcionário na página Configurações > API.
Por exemplo, se o funcionário cuja chave de API está a utilizar não tiver acesso a uma determinada localizações ou armazém, a troca de dados através desta chave de API com essa localização/armazém não será possível.
Capacidades da API
1. Pode criar o seu próprio widget “Work Order Status” para utilizar a pesquisa não por número de telefone, mas por número de ordem de serviço.
2. Pode ativar a criação automática de Leads ou Ordens de Serviço no RO App ao preencher o formulário no seu site.
Preste atenção aos tipos de campos no formulário de ordem de serviço/lead no RO App. Cada tipo tem as suas próprias restrições quanto ao número e tipo de caracteres.
Por exemplo, no formulário de ordem de serviço, o tipo de campo “Número da casa” é um número, e no seu site, o cliente pode introduzir uma letra neste campo. Neste caso, ocorrerá um erro e a ordem de serviço não será criada automaticamente com base no pedido do sítio Web.
3. Sincronização do estoque e dos preços dos produtos entre o RO App e o catálogo de produtos do seu site.
Tenha em atenção que ao vender produtos a partir do seu site, o produto não é automaticamente baixado do inventário do RO App e a venda não é automaticamente criada na página de vendas do RO App.
4. Troca de dados de clientes com vários serviços para geração de leads, cálculo de bônus, etc.
Estes são os exemplos mais comuns, uma vez que a utilização dos métodos API é muito diversificada 😉