Este guia apresenta como utilizar a documentação da API do UNO para integrar sistemas externos à plataforma, permitindo a criação de novos leads por meio de CRMs ou gerenciadores de anúncios, além do cadastro de novos agendamentos via API.
Possuir credenciais de API válidas (Access Token e Secret Key).
Conhecer os parâmetros obrigatórios exigidos por cada endpoint.
Ter acesso à documentação oficial da API.
Localize a categoria Lead na barra lateral da documentação da API e selecione o endpoint Cria um novo lead (POST).
https://readme.unobject.com.br/reference/post_lead
Na seção Body Params, preencha todos os campos identificados como required.
Para este endpoint, os parâmetros obrigatórios são:
name
cellPhone
Para autenticar as requisições, será necessário localizar as credenciais x-uno-access-token e x-uno-secret-key.
Na tela inicial do sistema de sua unidade, acesse o menu lateral > Configurações > Credenciais:
Copie a chave e o token de acesso
Informe os valores das credenciais nos campos x-uno-access-token e x-uno-secret-key para autenticar a requisição.
Após preencher todos os parâmetros obrigatórios e informar as credenciais:
Revise a requisição gerada automaticamente no painel cURL Request.
Clique em Try It! para enviar a requisição.
Analise a resposta retornada pela API.
200 – Sucesso: Lead criado com êxito.
403 – Proibido: Falha na autenticação ou permissões insuficientes.
500 – Erro interno: Ocorreu um erro interno no sistema.
Localize a categoria Scheduler na barra lateral da documentação da API e selecione o endpoint Cria um novo agendamento (POST).
https://readme.unobject.com.br/reference/post_scheduler-create
Na seção Body Params, preencha todos os campos identificados como required.
Para este endpoint, os parâmetros obrigatórios são:
date
hour
name
cellPhone
Informe a data desejada no parâmetro date para consultar os horários disponíveis para agendamento.
https://readme.unobject.com.br/reference/get_scheduler-hours
Para autenticar as requisições, será necessário localizar as credenciais x-uno-access-token e x-uno-secret-key.
Na tela inicial do sistema de sua unidade, acesse o menu lateral > Configurações > Credenciais:
Copie a chave e o token de acesso
Informe as credenciais x-uno-access-token e x-uno-secret-key para autenticar a requisição.
Após preencher os parâmetros obrigatórios:
Revise a requisição no painel cURL Request.
Clique em Try It!.
Analise a resposta retornada pela API.
200 – Sucesso:
O agendamento foi criado com sucesso.
403 – Proibido:
Falha na autenticação ou permissões insuficientes.
500 – Erro interno:
Ocorreu um erro durante o processamento da requisição.
Credenciais da API
Mantenha o Access Token e a Secret Key em segurança. Essas credenciais são utilizadas para autenticar as requisições da API e não devem ser compartilhadas com terceiros.
Parâmetros obrigatórios
Todos os campos identificados como required devem ser preenchidos para que a requisição seja processada corretamente. Caso algum parâmetro obrigatório não seja informado, a API retornará uma mensagem de erro.
Teste antes de implementar
Utilize o botão Try It! disponível na documentação para validar os parâmetros enviados e analisar a resposta da API antes de implementar a integração em seu sistema.
Análise das respostas
Caso a API retorne um código diferente de 200, consulte a mensagem retornada na resposta da requisição. Ela normalmente informa o motivo da falha e auxilia na correção dos parâmetros enviados.
Credenciais da unidade
As credenciais utilizadas para autenticação são exclusivas de cada unidade. Sempre utilize o Access Token e a Secret Key correspondentes à unidade que realizará a integração.
Ambiente de testes
Antes de utilizar a integração em produção, recomenda-se validar todas as requisições diretamente pela documentação da API utilizando o botão Try It!. Dessa forma, é possível verificar se os parâmetros, credenciais e respostas estão corretos antes da implementação no sistema externo.
