Permite listar os artigos cadastrados na Base de Conhecimento através da API do TomTicket.
Endpoint
https://api.tomticket.com/v2.0/kb/article/list
Método
GET
Content-Type
form-data
Autenticação
A autenticação da versão 2.0 da API é feita por Bearer Token Authentication.
Para realizar a autenticação, é necessário ter um Token de Acesso gerado.
Inclusão do Token nas Requisições:
Para acessar recursos da API, inclua o token de acesso no cabeçalho "Authorization" de suas requisições HTTP. O token deve ser precedido pela palavra Bearer e separado por um espaço, como no exemplo a seguir:
Authorization: Bearer seu_token_aqui
Parâmetros Opcionais via GET
Parâmetros enviados via queryString:
Coluna | Descrição da Coluna | Tipo |
|---|---|---|
page | O indice da pagina desejado para o resultado. | Int |
category_id | O hash identificador da categoria desejada | String |
Retorno
Detalhes do retorno em JSON da chamada da API.
Coluna | Descrição da Coluna | Tipo |
|---|---|---|
error | Informa se ocorreu um erro na operação. Se o retorno for false, então significa que a operação ocorreu com sucesso e não ocorreram problemas. Caso o retorno seja true, ocorreu um erro e será necessário verificar o campo mensagem para identificar o problema. | |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | |
success | Informando se tudo ocorreu com sucesso. | |
size | Total de itens encontrados. | |
pages | Total de páginas disponíveis para consulta. | |
next_page | Próxima página disponível para navegação. Retornará NULL caso não houver. | |
previous_page | Página anterior para navegação. Retornará NULL caso não houver. | |
data[id] | Identificador do artigo. | |
data[title] | Título do artigo. | |
data[url] | URL do artigo. | |
data[category[id]] | Identificador da categoria. | |
data[category[name]] | Nome da categoria. | String |
data[category[url]] | URL da categoria. | String |
data[category[primary[id]]] | Identificador da categoria pai, se houver. | String |
data[category[primary[name]]] | Nome da categoria pai. | |
data[category[primaryurl]]] | URL da categoria pai. | |