API simplificada para a implementação de processos personalizados
Uma API (Interface de Programação de Aplicativo) é geralmente usada por desenvolvedores para construir integrações entre aplicativos. Geralmente, com o no-code, você não usa APIs (porque é muito complexo), mas você usa o Zapier ou o Make.
Às vezes, nem todas as ações disponíveis no noCRM estão disponíveis no Zapier ou no Make. É aqui que entra a nossa API simplificada. Se a ação que você está procurando, como mover um lead para a próxima etapa do pipeline, não está disponível nativamente no Zapier ou no Make, mas está disponível na nossa API simplificada, então vamos mostrar como usá-la usando o Zapier ou o Make.
Como usar a API simplificada
Enquanto nossa API simplificada pode ser usada da mesma forma que nossa API normal por desenvolvedores, nós a construímos principalmente para ser usada por meio do Zapier e do Make por não desenvolvedores. A vantagem da API simplificada é que ela nos permite adicionar facilmente novas ações e torná-las disponíveis para uso em um curto período de tempo. Portanto, se você quiser usar uma ação que ainda não está disponível em nossa API simplificada, ficaríamos felizes em adicioná-la para que você crie seus processos exclusivos.
Zapier
No Zapier, para usar uma ação de nossa API simplificada, você precisa selecionar o evento de ação "Call Simplified API" e selecionar qual ação você deseja a partir da lista "Simplified API Path".
Make
No Make, há um recurso que permite chamar diretamente uma API. Você precisa primeiro criar um novo módulo, escolha o noCRM.io como aplicativo, e depois escolha "Make an API Call".
Depois disso, você só precisa colar o URL simplificada da API para a ação que deseja executar.
Usar a API simplificada no Make é um pouco menos amigável do que no Zapier. Requer que você entenda o que é um URL e quais são os parâmetros. No entanto, graças aos nossos tutoriais, você entenderá como funciona muito rapidamente.
Lista de ações disponíveis
Nesta seção, você encontrará uma lista de todas as ações disponíveis na API simplificada, bem como a documentação sobre como usá-las no Make, uma das plataformas no-code que usamos na noCRM.
Ao usar a API simplificada, você precisará substituir os marcadores vermelhos pelas informações corretas encontradas em sua conta noCRM.
Aprenda a configurar os parâmetros nas solicitações HTTP abaixo
Tudo depois do ponto de interrogação "?" nos URLs abaixo é um parâmetro. Um parâmetro é o que você pode configurar / definir na "Query String" ou no URL diretamente.
Exemplo:
Vamos supor que queremos designar leads a um usuário específico usando o Make.
1.Iremos colar o seguinte URL no módulo:
/simple/leads/LEAD_ID
/assign?user_id=YourEmail@maildomain.com
Você pode definir o valor do parâmetro "user_id" diretamente no URL, conforme mostrado acima, com o ID do usuário encontrado na página "IDs de objeto da conta" ou o endereço de e-mail do usuário. Isso informa ao Make a qual usuário da conta ele deve designar os leads recebidos.
2. Como alternativa, você pode definir o valor do "user_id" na Query String em vez de no URL:
Este método requer que você remova o parâmetro do URL e o adicione ao Query String:
/simple/leads/LEAD_ID
/assign
Query String:
A chave é: user_id
O valor é: YourEmail@maildomain.com
Observação: Todas as solicitações são sempre feitas no protocolo "GET". Não se preocupe se você não sabe o que isso significa. Estas são apenas informações adicionais para quem tem curiosidade ou está na área de desenvolvimento. Para os desenvolvedores puristas: sim, não deveria ser o método GET, mas é por isso que é uma API simplificada e não a nossa API REST completa. ?
Alterar o status do lead para 'Stand By'
Use o seguinte HTTP request para agendar o próximo lembrete para um determinado número de dias no futuro.
O parâmetro "days
"é mandatório. O parâmetro"activity_id
" é opcional, a solicitação funcionará com ou sem ele.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/standby?days=XX
&activity_id=YY
Example
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/standby?days=15
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/standby?days=15
&activity_id=23
Altere o status do lead para Ganho e insira um valor
Use o seguinte HTTP request par alterar o status de um lead para Ganho.
Opcional: Você também pode inserir o valor do lead
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/won?amount=XX
Example
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/won?amount=155.34
Alterar o status do lead para Cancelado
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/cancelled
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/cancelled
Alterar o status do lead para Perdido
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/lost
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/lost
Alterar o status do lead para Para Hoje
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/todo
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/todo
Designar um lead a um usuário de sua escolha
Use o seguinte HTTP request para designar um lead a um usuário em sua conta noCRM.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/assign?user_id=EmailADDRESS
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/assign?user_id=YourEmail@maildomain.com
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/assign?user_id=09846
Designar lead aleatoriamente a um usuário
Use o seguinte HTTP request para designar um lead aleatoriamente a um usuário.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/assign/random
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/assign/random
Designar lead aleatoriamente a um usuário, exceto para um administrador
Use o seguinte HTTP request para designar um lead aleatoriamente a um usuário, exceto para um administrador.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/assign/random?no_admin=true
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/assign/random?no_admin=true
Designar lead aleatoriamente a um usuário de uma equipe específica
Use o seguinte HTTP request para designar um lead aleatoriamente a um usuário de uma equipe específica.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/assign/random_in_a_team?team_id=TeamID
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/assign/random_in_a_team?team_id=24
Mover lead para a próxima etapa do pipeline
Use o seguinte HTTP request para mover um lead para a próxima etapa do pipeline
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/next_step
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/next_step
Mover lead para a etapa do pipeline de sua escolha
Use o seguinte HTTP request para mover um lead para a etapa do pipeline de sua escolha.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/move_to_step?step_id=StepID
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/move_to_step?step_id=23
Adicionar uma tag ao lead
Use o seguinte HTTP request para adiciar uma ou varias tags ao lead.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/add_tag?tag=TagName
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/add_tag?tag=ProductA
Você também pode adicionar várias tags de uma vez, apenas separe-as por vírgulas.
Exemplo: add_tag?tag=tag1
,tag2
,tag3
Enviar um modelo de e-mail para o lead
Use o seguinte HTTP request para enviar um modelo de e-mail da sua escolha para um lead. Enviará um e-mail para o e-mail de contato do lead e substituirá todos os campos do e-mail.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/send_email_from_template?email_template_id=TemplateID
&from_user_id=EmailADDRESS
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/send_email_from_template?email_template_id=12
&from_user_id=rana@xyzcorp.com
O parâmetro from_user_id
é o ID do usuário ou endereço de e-mail que envia o e-mail.
⚠️Importante: O e-mail não será enviado se:
- o usuário não puder acessar o modelo (apenas modelos compartilhados podem ser usados)
- ainda existirem variáveis no
assunto
oucorpo
após a substituição do modelo - não houver endereço de e-mail no lead
- o usuário remetente não sincronizou sua caixa de correio com sua conta noCRM
Registrar uma atividade
Use o seguinte HTTP request para registrar uma atividade no lead.
https://AccountName.nocrm.io/api/simple/leads/LEAD_ID
/add_activity?activity_id=ActivityID
&user_id=EmailADDRESS
&content=XXXXX
Exemplo
https://nocrmcorp.nocrm.io/api/simple/leads/145676
/add_activity?activity_id=45
&user_id=35
&content=Demo
O parâmetro content
é opcional. O activity_id
é obrigatório.