Central de Ajuda

Gerencie portais de ajuda, categorias e artigos. A central de ajuda permite criar uma base de conhecimento para seus clientes. Todos os endpoints são escopados à conta autenticada via prefixo /api/v1/accounts/{account_id}.

Portais

GET/api/v1/accounts/{account_id}/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",
      "config": {
        "default_locale": "pt_BR",
        "allowed_locales": [
          { "code": "pt_BR", "articles_count": 25, "categories_count": 5 }
        ]
      },
      "meta": { "all_articles_count": 25, "categories_count": 5 }
    }
  ]
}

POST/api/v1/accounts/{account_id}/portals

Cria um novo portal de ajuda.

Body (envolto em objeto portal)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome do portal
`slug`	`string`	Sim	Slug para URL
`custom_domain`	`string`	Nao	Domínio personalizado
`color`	`string`	Nao	Cor tema (hex)
`header_text`	`string`	Nao	Texto do cabeçalho do portal
`page_title`	`string`	Nao	Título da página
`homepage_link`	`string`	Nao	Link para página inicial
`config`	`object`	Nao	Config de locales: { default_locale, allowed_locales[], draft_locales[] }

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/portals" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "portal": {
      "name": "Central de Ajuda",
      "slug": "central-ajuda"
    }
  }'

Categorias

GET/api/v1/accounts/{account_id}/portals/{portal_slug}/categories

Lista categorias de um portal. O portal é identificado pelo SLUG (string), não por id numérico.

200Lista de categorias (articles_count vive em meta)

json

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

POST/api/v1/accounts/{account_id}/portals/{portal_slug}/categories

Cria uma categoria no portal.

Body (envolto em objeto category)

Nome	Tipo	Obrigatorio	Descricao
`name`	`string`	Sim	Nome da categoria
`description`	`string`	Nao	Descrição da categoria
`slug`	`string`	Nao	Slug para URL
`locale`	`string`	Nao	Idioma (pt_BR, en)
`position`	`integer`	Nao	Posição na ordenação
`icon`	`string`	Nao	Ícone da categoria
`parent_category_id`	`integer`	Nao	ID da categoria pai

bash

curl -X POST "https://chat.seudominio.com/api/v1/accounts/1/portals/central-ajuda/categories" \
  -H "api_access_token: YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "category": {
      "name": "Primeiros Passos",
      "locale": "pt_BR"
    }
  }'

Artigos

GET/api/v1/accounts/{account_id}/portals/{portal_slug}/articles

Lista artigos de um portal com paginação.

Parâmetros

Nome	Tipo	Obrigatorio	Descricao
`page`(query)	`integer`	Nao	Página
`category_slug`(query)	`string`	Nao	Filtrar por slug da categoria (o filtro é por slug, não por id)
`status`(query)	`string`	Nao	Status: draft, published, archived

bash

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

POST/api/v1/accounts/{account_id}/portals/{portal_slug}/articles

Cria um novo artigo.

Body (envolto em objeto article)

Nome	Tipo	Obrigatorio	Descricao
`title`	`string`	Sim	Título do artigo
`content`	`string`	Sim	Conteúdo (Markdown)
`category_id`	`integer`	Nao	Categoria
`author_id`	`integer`	Nao	ID do autor (agente)
`status`	`string`	Nao	Status: draft, published, archived
`description`	`string`	Nao	Resumo do artigo
`slug`	`string`	Nao	Slug para URL
`locale`	`string`	Nao	Idioma do artigo

bash

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