Integracao Rest URL Authentication

De Bemmelhor Wiki
Ir para: navegação, pesquisa

Projeto BM Integração

Este projeto foi desenvolvido para permitir a integração entre o BmTelecom e as ferramentas de parceiros da empresa Bemmelhor SI. Através deste modelo de integração é possível realizar atividades como discagem direta via Rest (click to dial) e captura de dados para geração de relatórios de integração.

O padrão de autenticação utilizado pelo lado servidor é via HTTP, onde os dados de usuário e senha podem ser passados diretamente pela URL. Para adquirir um usuário e senha para os ambientes de homologação e produção é necessário entrar em contato com a equipe de Suporte Técnico da Bemmelhor SI através do email suporte@bemmelhor.com.br ou pelo telefone (32) 3211.0536. Caso queira utiliza o padrão de autenticação mais seguro, utilize o Modelo de Integração com Basic Authentication.

Serviços Info

Endpoint Básico

Recurso Descrição
URI http://IP.SERVER:3021/bmtelecom
GET Retorna dados básicos do servidor de integração.
{
  "status": true,
  "result": "Success / Conectado",
  "description": "BmIntegracao - BmTelecom Integration",
  "version": "0.1.0 beta"
}


Serviço Informações da Integração

Recurso Descrição
URI http://IP.SERVER:3021/bmtelecom/:KEY/info/
GET Retorna dados básicos do servidor de integração.
{
  "success": true,
  "description": "BmIntegracao - BmTelecom Integration",
  "version": "0.1.0 beta",
  "telecom": {
    "host": "127.0.0.1"
  }
}

Serviço Click to Dial

Recurso Descrição
URI http://IP.SERVER:3021/bmtelecom/:KEY/dial/:SIP/:PHONE
GET Realiza uma discagem pelo sistema de telefonia.
{
  "status": "200",
  "description": "Ligacao Processada"
}

Baixa de Gravação

Recurso Descrição
URI http://IP.SERVER:3021/bmtelecom/:KEY/recorder/:ID
GET Baixa uma gravação pelo id do registro.
Retorna o arquivo para download