API - Documentação

Introdução às APIs

A API NicoChat é usada para recuperar dados do fluxo que você constrói. Aqui estão alguns exemplos que você pode fazer com a API NicoChat.

• Extraia o fluxo que você construiu do NicoChat.
• Crie, exclua ou obtenha dados, incluindo tag de fluxo, campo de fluxo.
• Tratar os dados dos assinantes, envolvendo a obtenção das informações dos assinantes, a edição de sua tag ou campo e também o subfluxo enviado aos assinantes.
• 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 apresentarão as etapas para usar a API NicoChat.

Autorizar

Como a proteção dos dados é importante para a API, ela precisa utilizar diversos atributos para autorizar sua identidade. Portanto, o primeiro passo que você deve realizar é inserir as informações autorizadas. Você precisa clicar no botão Autorizar, conforme mostrado na figura a seguir.

Então, existem três atributos que você precisa preencher na caixa de texto.

Aqui estão as maneiras de encontrar esses atributos na seção a seguir.

Gerar chave de API (http,Bearer)

Passo 1 Depois de fazer login na conta no NicoChat, no canto superior direito, será mostrado o nome da sua conta e avatar. Clique nele e escolha Suas configurações na lista suspensa.

Etapa 2 Vá para a seção Chaves de API clicando no botão na configuração do usuário. Digite o nome da chave que você deseja definir e clique no botão Criar.

Passo 3 Em seguida, 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.

Obtenha o URL Curl e Solicitação

Curl é usado em solicitações de API. Na documentação da API do NicoChat, você precisa de alguma operação antes de obter o curl na documentação da API do NicoChat.

Aqui, usamos Get Flow Tag como exemplo.

Passo 1. Clique na operação de expansão da 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 logotipo significa autorizar. Se você já fez isso antes, esta etapa não é necessária. Ou você simplesmente faz o mesmo mencionado anteriormente na seção Autorizar.

Etapa 3. Clique em Experimente. Então você verá que a parte do corpo Parâmetros ou Solicitação pode ser inserida e o botão Exexute é mostrado na parte inferior desta parte.

Etapa 4. Insira os parâmetros ou o corpo da solicitação necessários e clique no botão Exexute. Finalmente você obterá o URL Curl e Request.

Respostas

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á erro na sua resposta.

Exemplo de valor/esquema

Além do valor de exemplo, você pode clicar em “Esquema” para ver mais detalhes como qual valor é obrigatório.