Este método é utilizado para a leitura individual de artigos da base de conhecimento.
Endpoint
| Método | Rota | Content-Type |
|---|
GET | https://api.tomticket.com/v2.0/kb/article/read | form-data |
Autenticação
Este endpoint utiliza autenticação Bearer Token.
Authorization: Bearer SEU_TOKEN_AQUI
Caso ainda não possua um Token de Acesso, consulte o artigo Criação do Token de Acesso.
Parâmetros da requisição
Parâmetros da requisição - Leitura de Artigos
| Campo | Tipo | Obrigatório | Tamanho máximo | Descrição |
|---|
article_id | string | Sim | - | O hash identificador do artigo desejado. |
JSON de saída
JSON de saída - Leitura de Artigos
| Campo | Tipo | Descrição |
|---|
error | boolean | Informa se ocorreu um erro na operação. |
message | string | Detalhes da operação, caso tenha ocorrido ou não um problema. |
success | boolean | Informando se tudo ocorreu com sucesso. |
data | object | Detalhes do artigo retornado pela API. |
id | string | Identificador do artigo. |
title | string | Título do artigo. |
url | string | Url do artigo. |
content | string | Conteúdo do artigo. |
category | object | Categoria do artigo. |
id | string | Identificador da categoria. |
name | string | Nome da categoria. |
url | string | URL da categoria. |
primary | object | Categoria pai, se houver. |
id | string | Identificador da categoria pai, se houver. |
name | string | Nome da categoria pai. |
url | string | URL da categoria pai. |
Código 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. |
Agradecemos sua avaliação.