Este método permite listar todas as categorias de artigos da sua conta.
Endpoint
https://api.tomticket.com/v2.0/kb/category/list
Método HTTP
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 índice da página desejado para o resultado | Int |
Retorno
Descrição do retorno em JSON.
| 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. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Retorna true caso a operação tenha sido concluída com sucesso. | Boolean |
size | Total de itens encontrados. | Int |
pages | Total de páginas disponíveis para consulta | Int |
next_page | Próxima página disponível para navegação. Retornará NULL caso não houver. | Int |
previous_page | Página anterior para navegação. Retornará NULL caso não houver. | Int |
data | Lista com as categorias cadastrados. | Array |
| Identificador da categoria. | String |
| Nome da categoria. | String |
| URL pública do domínio da conta + URL amigável para acesso. | String |
| Identificador da categoria. | String |
data child name | Nome da categoria. | String |
data child url | URL pública do domínio da conta + URL amigável para acesso. | String |
Código de Retorno
Descrição do código HTTP de retorno.
| Código | Descrição |
|---|---|
| 200 | Operação realizada com sucesso. |
| 401 | Token ou valores enviados não autorizados para uso. |
| 403 | Recurso não disponível. |
| 404 | Recurso não encontrado. |