Ir para o conteúdo principal

7.1 API Rest

Integração via API REST

Para integrações, o CRM One disponibiliza uma API REST para consumo externo.

Instalação

Para instalar a API, é necessário abrir um chamado para a equipe de suporte solicitando a instalação.

Funcionamento

O endereço local da API pode ser encontrado no Event Viewer (Visualizador de Eventos) do servidor onde a API foi instalada, conforme o exemplo abaixo:

image.png

  • IP do servidor: 192.168.1.100
  • Porta configurada: 8052
  • Banco de dados: SBODemoBR
  • Endpoint raiz: http://192.168.1.100:8052/SBODemoBR/DWUAPI

Lembre-se de configurar corretamente as regras de IP e direcionamento de portas no firewall ou roteador da rede.


Adição de Atendimento

URL de exemplo:

http://192.168.1.100:8052/SBODemoBR/DWUAPI/AdicionaAtendimento

image.png



JSON de exemplo para requisição:

{
  "oPropriedade": {
    "EmailUsuario": "manager",
    "SenhaUsuario": "1234"
  },
  "oAtendimento": {
    "DocEntry": 0,
    "U_AssuntoAtual": "2",
    "U_CardCode": "C20000",
    "U_CardName": "Maxi-Teq do Brasil LTDA",
    "U_CodTipoAtendimento": 8,
    "U_NomTipoAtendimento": "SAC",
    "U_DtEncerramento": "01/07/2022",
    "U_DtProxContato": "02/07/2022",
    "U_HrProxContato": "00:00",
    "U_EquiProxContato": null,
    "U_Assunto": "Assunto do atendimento",
    "U_Prioridade": "1",
    "U_Status": "C",
    "U_Latitude": "",
    "U_Longitude": "",
    "U_Classifica": "",
    "listaDeAnexos": [],
    "U_TipoProxContato": 1,
    "U_UsrProxContato": 1,
    "U_AssuntoAtual_Desk": null
  },
  "sParecer": [
    "Corpo do texto, onde deve constar todas as infomações (Parecer/histórico)"
  ]
}

 Para testar via Postman, configure uma requisição POST com o JSON acima no corpo da requisição.

image.png

Retorno de sucesso (exemplo)

Se o atendimento for adicionado com sucesso, a API retornará o seguinte JSON:

{
  "Retorno": {
    "Dados": {
      "DocEntry": "264",
      "DocNum": "264",
      "U_CardCode": "C20000",
      "U_CardName": "Maxi-Teq do Brasil LTDA",
      "U_NomTipoAtendimento": "SAC",
      "U_Assunto": "Assunto do atendimento",
      "U_DtEncerramento": "01/07/2022",
      "U_DtProxContato": "02/07/2022",
      "U_HrProxContato": "0000",
      "U_Status": "C",
      "U_TipoProxContato": "1",
      "U_UsrProxContato": "1",
      "ListaAtendimentoDWU_ATEND_PARECER": [
        {
          "Atividade": {
            "AssuntoParecer": "Abert. automática",
            "Notes": "Corpo do texto, onde deve constar todas as infomações (Parecer/histórico)",
            "BeginTime": "16:52",
            "Recontact": "11/07/2022"
          }
        }
      ]
    },
    "MensagemErro": "",
    "Status": 1
  }
}