Este método é utilizado para a leitura individual de artigos da base de conhecimento.
Endpoint
https://api.tomticket.com/v2.0/kb/article/read
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 Query String
Parâmetros enviados via queryString:
| Coluna | Descrição da Coluna | Tipo |
|---|---|---|
article_id | O hash identificador do artigo desejado. | 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. | Boolean |
message | Detalhes da operação, caso tenha ocorrido ou não um problema. | String |
success | Informando se tudo ocorreu com sucesso. | Boolean |
data[id] | Identificador do artigo. | String |
data[title] | Título do artigo. | String |
data[url] | Url do artigo. | String |
data[content] | Conteúdo do artigo. | String |
data[category[id]] | Identificador da categoria. | String |
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. | String |
data[category[primary[url]]] | URL da categoria pai. | 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. |