/
Informações Gerais - APIs Service Desk - v0.5

Informações Gerais - APIs Service Desk - v0.5

Especificação API Service Desk Open Finance Brasil

O objetivo desse documento é prover material para publicação das informações referentes a APIs do Service Desk no portal do Open Finance Brasil.

A Documentação completa e também utilizada como fonte deste conteúdo pode ser encontrada em: SysAid Community | Community

1. Modelo de Fluxo de atendimento:

2. URLs de acesso:

https://servicedesk.openfinancebrasil.org.br/ : Ambiente Produtivo do Service Desk Open Finance.

https://servicedesksandbox.openfinancebrasil.org.br/ : Ambiente Sandbox (Homologação) do Service Desk Open Finance.

3. Tabela DE/PARA front-end para API

Nome do Campo

API

Detalhes

Categoria

problem_type

1ºNível_2ºNível_3ºNível / Na resposta: 1º Nível de Categoria

Subcategoria

problem_sub_type

Na resposta: 2º Nível de Categoria

Categoria de 3º Nível

third_level_category

Na resposta: 3º Nível de Categoria

Título

title

 

Descrição

description

 

Anotações

notes

{“userName”:{NOME DO USUÁRIO},”createDate”:{DATA EM MILISEGUNDOS},”text”:{TEXTO}}

Solução

solution

 

Atividades

activities

Iterações entre N1 e N2

Data de solicitação

insert_time

Em milisegundos

Data de modificação

uptade_time

Em milisegundos

Data de encerramento

close_time

Em milisegundos

Prazo de SLA

due_date

Em milisegundos

Data Prevista para Implementação da

Correção

 

CustomColumn82sr

Necessária quando utilizado o status “AGUARDANDO CORREÇÃO N2” em categorias de Incidentes

Usuário Solicitante

request_user

 

Equipe de Atendimento

assigned_group

 

Especialista Atribuído

responsibility

 

Status

status

Conferir lista de status

Contador de Reabertura

reopen_counter

Número de vezes que o chamado foi reaberto

Anexos

attachments

 

Tipo de Registro de

Serviço

sr_type

 

Arquivado

arquive

Tipo Booleano

Nível de Suporte Atual

current_support_level

 

Tipo do Chamado

type

Incidentes = 1; Solicitação de Serviço = 10

Formulário Utilizado

template

Padrão Incidente = 20; Padrão Solicitação de Serviço = 12

O conteúdo da

reclamação é procedente?

CustomColumn129sr

Necessário o preenchimento ao encaminhar um chamado tipo Incidente para encerramento

(status: ENCAMINHADO N1 ENCERRAMENTO)

Tipo de Erro

CustomColumn119sr

Disponível apenas para consulta nos chamados da categoria “Erro na Jornada ou Dados”

4. APIs

Tipo de API: REST

Formato dos dados de retorno e envio: JSON Fonte do conteúdo:

SysAid Community | Community

FAQ Service Desk: https://servicedesk.openfinancebrasil.org.br/KBFAQTree.jsp

4.1 Login

Responsável pela autenticação na API, é pré-requisito para a execução de qualquer requisição. As credenciais devem ser solicitadas via Portal do Service Desk Open Finance.

É necessário um usuário Administrador (Atendimento N2) para a utilização da API.

POST - {URL}/api/v1/login

 

Campos Obrigatórios:

“user_name” = Nome de usuário de integração “password” = Senha do usuário de integração

 

Exemplo de Body:

{"user_name":"{NOME DO USUÁRIO}", "password":"{SENHA}"}

No retorno é necessário armazenar o Cookie JSESSIONID para consumo dos demais métodos.

Nesta requisição de login, também é necessário identificar o ID do Grupo de Atendimento que será utilizado nas requisições de consulta de chamados, para identificar este número na resposta deve ser capturado o valor do "id" na key "user_groups". De acordo com o exemplo a seguir:

"key": "user_groups", "value": [