API
Confira os detalhes da API na Documentação Swagger
A referência interativa de todos os endpoints fica na Documentação Swagger do NicoChat. São 247 operações em 230 endpoints, agrupadas em 25 áreas do produto.
Você também pode importar a Collection no Postman clicando aqui!
A API NicoChat é usada para recuperar dados do fluxo que você constrói. Veja alguns exemplos do que você pode fazer com ela.
- Extraia do NicoChat o fluxo que você construiu.
- Crie, exclua ou obtenha dados, incluindo tag de fluxo e campo de fluxo.
- Trate os dados dos inscritos: obtenha as informações do inscrito e edite sua tag ou campo, bem como o subfluxo enviado a ele.
- Configure todos os dados utilizados no e-commerce, como carrinhos ou produtos.
Se você precisar lidar com os dados abaixo, as próximas seções apresentam as etapas para usar a API NicoChat.
Toda chamada sai da URL base https://app.nicochat.com/api, é autenticada com Bearer mais a sua chave de API e responde em JSON. Cada grupo exige um escopo na chave — Manage Flow, Manage Team ou Send Message —, indicado na descrição do endpoint no Swagger.
Como a proteção dos dados é importante para a API, ela precisa de vários atributos para autorizar sua identidade. Por isso, o primeiro passo é inserir as informações de autorização. Clique no botão Authorize, como mostra a figura a seguir.
Em seguida, há três atributos que você precisa preencher na caixa de texto.
Veja na seção a seguir como encontrar esses atributos.
Passo 1. Depois de entrar na sua conta do NicoChat, o nome da conta e o avatar aparecem no canto superior direito. Clique neles e escolha Configurações da Conta na lista suspensa.
Passo 2. Vá para a seção Chaves de API clicando no botão nas configurações do usuário. Digite o nome da chave que você quer definir e clique no botão Criar.
Passo 3. Você receberá a chave em uma janela pop-up.
Feche a janela e você obterá as informações básicas sobre a chave, exceto o valor da chave.
O curl é usado nas solicitações de API. Na documentação da API do NicoChat, você precisa realizar algumas operações antes de obtê-lo.
Aqui, usamos Get Flow Tag como exemplo.
Passo 1. Clique para expandir a categoria, neste caso o Flow Tag. Em seguida, encontre a ação e o recurso Get /flow/tags. Clique na linha e uma página suspensa será exibida, conforme a seguir.
Passo 2. Este ícone significa autorizar. Se você já fez isso antes, esta etapa não é necessária. Caso contrário, repita o que foi descrito na seção Autorizar.
Passo 3. Clique em Experimente. Em seguida, você verá que a parte Parâmetros ou Corpo da solicitação pode ser preenchida e que o botão Execute aparece na parte inferior dessa área.
Passo 4. Insira os parâmetros ou o corpo da solicitação necessários e clique no botão Execute. Por fim, você obterá o Curl e a URL de Solicitação.
Esta parte exibe o resultado JSON que você obterá da API NicoChat. Normalmente, se o código for 200, significa que você obteve a resposta com sucesso. Se o código for 400, significa que há um erro na sua resposta.
Além do valor de exemplo, você pode clicar em “Esquema” para ver mais detalhes, como qual valor é obrigatório.
