Atualmente o OcoMon implementa dois métodos para integração via API Rest: Create() e Read():

Create()

Método para abertura de chamados:

  • Verbalização: POST
  • URL: {{ocomon_site}}/api/ocomon_api/tickets/
  • Headers:
    • app: nome da aplicação. Precisa ser registrada via painel de administração em Admin::API::Aplicações via API;
    • login: nome de usuário com acesso para a aplicação. Definido em Admin::API::Tokens de Acesso;
    • token: token JWT vinculado à aplicação e ao respectivo usuário. Definido em Admin::API::Tokens de Acesso;
  • Body:
    • string description (obrigatório): Descrição do chamado
    • int area (opcional): código válido de área de atendimento
    • string contact (opcional): campo contato
    • string contact_email (opcional): campo e-mail do contato
    • string phone (opcional): campo de telefone do contato
    • int issue (opcional): código válido de tipo de problema
    • int status (opcional): código válido de tipo de status
    • int asset_unit (opcional): código válido de unidade
    • string asset_tag (opcional): número/identificação da etiqueta do equipamento
    • int priority (opcional): código válido de prioridade
    • string input_tag (tags separadas por vírgula) (opcional): rótulos/tags que serão incorporados ao chamado
    • int operator (opcional): código válido de operador, caso o chamado esteja sendo encaminhado diretamente a um operador específico
    • int channel (opcional): código válido de canal de solicitação
Headers para o método Create()
Body para o método Create()
Resposta do método Create()

Read()

Método para leitura de chamados:

  • Verbalização: GET
  • URL: {{ocomon_site}}/api/ocomon_api/tickets/{{número do chamado}}
  • Headers:
    • app: nome da aplicação. Precisa ser registrada via painel de administração em Admin::API::Aplicações via API;
    • login: nome de usuário com acesso pela aplicação. Definido em Admin::API::Tokens de Acesso;
    • token: token JWT vinculado à aplicação e ao usuário com permissão de acesso. Definido em Admin::API::Tokens de Acesso;
Header e Resposta do método Read()

Com o tempo e a evolução do projeto, novos métodos poderão ser adicionados.