Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

A integração pode ser configurada de forma personalizada nos fluxos do sistema Salesforce, utilizando a API OZmap. Esta documentação exemplifica como pode ser implementada e utilizada a funcionalidade de Consulta de Viabilidade no OZmap para o Salesforce, porém, muitas outras funcionalidades OZmap podem ser incorporadas nos fluxos Salesforce utilizando a API OZmap. Consulte a documentação https://ozmap.atlassian.net/l/cp/CKJMvNge para mais informações sobre funcionalidades indicadas para implementação.

Resumo de funcionalidades

...

Abaixo está descrita a funcionalidade de exemplo, de forma a entender como funciona seu fluxo e como pode ser feita sua implementação dentro do no Salesforce.

Consulta de Viabilidade

...

  • Para realizar a consulta de viabilidade no OZmap, é necessário dispor das coordenadas do novo cliente. A consulta de viabilidade feita pela API OZmap busca por caixas que não esteja com estado de implantação “Em projeto”, e contenham algum Splitter de atendimento com portas disponíveis;

  • Com as coordenadas do cliente, basta realizar configurar o fluxo Salesforce para realizar uma requisição API ao OZmap no momento de verificação de viabilidade, passando essas as coordenadas como do cliente por parâmetro:

    • Code Block
      https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944
  • O retorno esperado desta requisição é um arquivo json contendo uma lista de todas as caixas encontradas de acordo com as configurações de viabilidade definidas no OZmap, com os seguintes atributos:

    • viable: Apresenta um valor booleano, indicando se há viabilidade ou não na localização informada;

    • boxes: Lista de todas as caixas com disponibilidade que foram encontradas no raio de busca, com mostrando a distância, número de portas disponíveis, nome da caixa, entre outras informações;

    • refused_boxes: Lista de caixas que forma foram encontradas dentro do raio de busca, mas que não possuem disponibilidade para atender clientes no momento.

  • AdicionamentoAdicionalmente, podem ser passados utilizados mais parâmetros nesta requisição, como por exemplo:

    • Definir um raio, em metros, para a busca de caixas (radius): O raio de busca padrão utilizado na viabilidade é o que estiver definido nas configurações de viabilidade do OZmap, mas pode ser utilizado um raio diferente passando um valor em metros por parâmetro. Exemplo:

      • Code Block
        https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944&return_typeradius=boolean50
    • Definir retorno booleano (return_type=boolean): Com este parâmetro, o retorno da requisição será um json contendo apenas o atributo “viable", que pode assumir o valor “true” caso haja viabilidade na localidade informada, ou “false” caso não haja viabilidade. Exemplo:

      • Code Block
        https://cliente.ozmap.com.br:9994/api/v2/ftth-viability/radius?lat=-27.57635071150383&lng=-48.52777004241944&radiusreturn_type=50boolean

Dados Acesso

Dados de acesso necessários para as operações realizadas pelo integrador são:

...