Central de Ajuda

Gerencie portais de ajuda, categorias e artigos. A central de ajuda permite criar uma base de conhecimento publica para seus clientes.

Portais

GET/api/v1/portals

Lista todos os portais de ajuda.

200Lista de portais

json

{
  "payload": [
    {
      "id": 1,
      "name": "Central de Ajuda",
      "slug": "central-ajuda",
      "custom_domain": "ajuda.empresa.com",
      "articles_count": 25,
      "categories_count": 5
    }
  ]
}

POST/api/v1/portals

Cria um novo portal de ajuda.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome do portal
`slug`	`string`	Sim	Slug para URL
`custom_domain`	`string`	Nao	Dominio personalizado
`color`	`string`	Nao	Cor tema (hex)
`homepage_link`	`string`	Nao	Link para pagina inicial

Categorias

GET/api/v1/portals/{portal_id}/categories

Lista categorias de um portal.

200Lista de categorias

json

{
  "payload": [
    {
      "id": 1,
      "name": "Primeiros Passos",
      "slug": "primeiros-passos",
      "position": 1,
      "articles_count": 8
    }
  ]
}

POST/api/v1/portals/{portal_id}/categories

Cria uma categoria no portal.

Body

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da categoria
`locale`	`string`	Nao	Idioma (pt_BR, en)
`position`	`integer`	Nao	Posicao na ordenacao

Artigos

GET/api/v1/portals/{portal_id}/articles

Lista artigos de um portal com paginacao.

Parametros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Pagina
`category_id`(query)	`integer`	Nao	Filtrar por categoria
`status`(query)	`string`	Nao	Status: draft, published, archived

bash

curl -s "https://chat.seudominio.com/api/v1/portals/1/articles?status=published" \
  -H "api_access_token: YOUR_TOKEN" | jq .

POST/api/v1/portals/{portal_id}/articles

Cria um novo artigo.

Body

Nome	Tipo	Obrigatorio	Descricao
`title`	`string`	Sim	Titulo do artigo
`content`	`string`	Sim	Conteudo (Markdown)
`category_id`	`integer`	Nao	Categoria
`status`	`string`	Nao	Status: draft, published
`description`	`string`	Nao	Resumo do artigo

bash

curl -X POST "https://chat.seudominio.com/api/v1/portals/1/articles" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Como configurar o WhatsApp",
    "content": "# Configurando WhatsApp\n\nPasso 1: ...",
    "category_id": 1,
    "status": "published"
  }'