Code blocks:

bash curl -X POST
'https://api.toolzz.com.br/api/v1/helpcenter/portals'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer SEU_TOKEN_API'
-d '{ "name": "Central de Ajuda Toolzz", "description": "Portal de ajuda para clientes Toolzz", "url": "https://ajuda.toolzz.com.br" }'

javascript const axios = require('axios');

const data = JSON.stringify({ "name": "Central de Ajuda Toolzz", "description": "Portal de ajuda para clientes Toolzz", "url": "https://ajuda.toolzz.com.br" });

const config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.toolzz.com.br/api/v1/helpcenter/portals', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer SEU_TOKEN_API' }, data : data };

axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); });

python import requests import json

url = "https://api.toolzz.com.br/api/v1/helpcenter/portals"

payload = json.dumps({ "name": "Central de Ajuda Toolzz", "description": "Portal de ajuda para clientes Toolzz", "url": "https://ajuda.toolzz.com.br" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer SEU_TOKEN_API' }

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Response JSON:

{ "id": 123, "name": "Central de Ajuda Toolzz", "description": "Portal de ajuda para clientes Toolzz", "url": "https://ajuda.toolzz.com.br", "created_at": "2023-10-27T14:30:00Z", "updated_at": "2023-10-27T14:30:00Z" }

Criar uma Nova Categoria

Para criar uma nova categoria, use o seguinte endpoint:

• URL: /api/v1/helpcenter/portals/{portal_id}/categories
• Método: POST
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer SEU_TOKEN_API
• Body:

{ "name": "Primeiros Passos", "description": "Artigos para começar a usar o Toolzz Chat" }

Tabela de parâmetros:

Code blocks:

bash curl -X POST
'https://api.toolzz.com.br/api/v1/helpcenter/portals/123/categories'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer SEU_TOKEN_API'
-d '{ "name": "Primeiros Passos", "description": "Artigos para começar a usar o Toolzz Chat" }'

javascript const axios = require('axios');

const data = JSON.stringify({ "name": "Primeiros Passos", "description": "Artigos para começar a usar o Toolzz Chat" });

const config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.toolzz.com.br/api/v1/helpcenter/portals/123/categories', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer SEU_TOKEN_API' }, data : data };

axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); });

python import requests import json

url = "https://api.toolzz.com.br/api/v1/helpcenter/portals/123/categories"

payload = json.dumps({ "name": "Primeiros Passos", "description": "Artigos para começar a usar o Toolzz Chat" }) headers = { 'Content-Type': 'application/json', 'Authorization': 'Bearer SEU_TOKEN_API' }

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Response JSON:

{ "id": 456, "name": "Primeiros Passos", "description": "Artigos para começar a usar o Toolzz Chat", "portal_id": 123, "created_at": "2023-10-27T14:30:00Z", "updated_at": "2023-10-27T14:30:00Z" }

Criar um Novo Artigo

Para criar um novo artigo, use o seguinte endpoint:

• URL: /api/v1/helpcenter/categories/{category_id}/articles
• Método: POST
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer SEU_TOKEN_API
• Body:

{ "title": "Como configurar o Toolzz Chat", "content": "

Este artigo explica como configurar o Toolzz Chat passo a passo.

Tabela de parâmetros:

Code blocks:

bash curl -X POST
'https://api.toolzz.com.br/api/v1/helpcenter/categories/456/articles'
-H 'Content-Type: application/json'
-H 'Authorization: Bearer SEU_TOKEN_API'
-d '{ "title": "Como configurar o Toolzz Chat", "content": "

Este artigo explica como configurar o Toolzz Chat passo a passo.

javascript const axios = require('axios');

const data = JSON.stringify({ "title": "Como configurar o Toolzz Chat", "content": "

Este artigo explica como configurar o Toolzz Chat passo a passo.

const config = { method: 'post', maxBodyLength: Infinity, url: 'https://api.toolzz.com.br/api/v1/helpcenter/categories/456/articles', headers: { 'Content-Type': 'application/json', 'Authorization': 'Bearer SEU_TOKEN_API' }, data : data };

axios.request(config) .then((response) => { console.log(JSON.stringify(response.data)); }) .catch((error) => { console.log(error); });

python import requests import json

url = "https://api.toolzz.com.br/api/v1/helpcenter/categories/456/articles"

payload = json.dumps({ "title": "Como configurar o Toolzz Chat", "content": "

Este artigo explica como configurar o Toolzz Chat passo a passo.

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Response JSON:

{ "id": 789, "title": "Como configurar o Toolzz Chat", "content": "

Este artigo explica como configurar o Toolzz Chat passo a passo.

Webhooks

O Toolzz Chat também oferece webhooks que permitem receber notificações em tempo real sobre eventos relacionados ao Help Center. Por exemplo, você pode configurar um webhook para ser notificado quando um novo artigo é criado, atualizado ou excluído. Isso pode ser útil para sincronizar seu Help Center com outros sistemas ou para monitorar a atividade da sua equipe.

Para configurar um webhook, use o seguinte endpoint:

• URL: /api/v1/webhooks
• Método: POST
• Headers:
  • Content-Type: application/json
  • Authorization: Bearer SEU_TOKEN_API
• Body:

{ "event": "helpcenter.article.created", "url": "https://seu-servidor.com/webhook", "status": "active" }

Tabela de parâmetros:

Testando a Integração

Após implementar a integração via API e configurar os webhooks, é importante testar para garantir que tudo esteja funcionando corretamente. Aqui estão algumas dicas:

• Crie, atualize e exclua artigos via API: Verifique se as operações são realizadas com sucesso e se os dados são sincronizados corretamente no Toolzz Chat.
• Verifique os webhooks: Crie, atualize e exclua artigos e verifique se as notificações são enviadas para a URL configurada. Certifique-se de que seu servidor está recebendo e processando as notificações corretamente.
• Acesse o Help Center como cliente: Verifique se os artigos são exibidos corretamente e se a pesquisa está funcionando como esperado.

Erros Comuns e Troubleshooting

Ao implementar a integração com a API do Toolzz Chat, você pode encontrar alguns erros comuns. Aqui estão algumas dicas para solucioná-los:

• Erro de autenticação: Verifique se o token de API está correto e se você está incluindo-o no header Authorization da requisição.
• Erro de permissão: Verifique se o token de API tem as permissões necessárias para realizar a operação.
• Erro de validação: Verifique se os dados que você está enviando no body da requisição são válidos e соответem ao schema esperado.
• Erro de servidor: Se você receber um erro de servidor (status code 500), tente novamente mais tarde ou entre em contato com o suporte do Toolzz Chat.

Alternativas Gratuitas: Vale a Pena?

Existem diversas alternativas gratuitas para criar um Help Center, como o Google Sites, o Notion e o WordPress com plugins. Essas opções podem ser atraentes para empresas com orçamentos limitados, mas é importante considerar suas limitações.

Enquanto as alternativas gratuitas podem ser um bom ponto de partida, o Toolzz Chat oferece uma solução mais completa e escalável, com recursos avançados, integrações nativas e suporte dedicado. Para empresas que priorizam a experiência do cliente e a eficiência do suporte, o investimento no Toolzz Chat pode trazer um retorno significativo.

Concorrentes como Zendesk, Freshdesk e HelpScout também oferecem soluções de Help Center, mas o Toolzz Chat se destaca pela sua integração nativa com outras ferramentas da Toolzz, como Toolzz AI e Toolzz Bots, permitindo criar um fluxo de atendimento completo e automatizado. Além disso, o Toolzz Chat oferece uma interface mais moderna e intuitiva, tornando a gestão do Help Center mais fácil e eficiente.

Conclusão

Implementar um Help Center eficiente é fundamental para melhorar a experiência do cliente e reduzir a carga sobre a equipe de suporte. A API do Toolzz Chat oferece uma forma poderosa e flexível de gerenciar seu Help Center, permitindo criar, atualizar e excluir artigos, categorias e portais de forma programática. Embora existam alternativas gratuitas, o Toolzz Chat oferece uma solução mais completa, escalável e integrada, tornando-se a melhor opção para empresas que buscam excelência no atendimento ao cliente.

Potencialize com agentes de IA da Toolzz

O Toolzz Chat cuida do atendimento humano. Mas e se um agente de IA da Toolzz AI respondesse as primeiras perguntas, qualificasse o lead, e só transferisse para o humano quando necessário? Com Custom Functions, seu agente consulta CRM, agenda reuniões e resolve problemas — tudo por WhatsApp. Já imaginou interagir com essa automação por voz?