Opens-Contacts

Este modulo é uma solução abrangente para autenticação que reúne alguns os módulos essenciais necessários para interagir com a base de dados de contatos da sua empresa no Yunique

Prerequisitos

Esse projeto exige que você possua algumas informações

| Variavel | Descrição | | ------------------------ | -------------------------------------------------------------------- | | ID da empresa | Código unico de acesso da sua empresa. Exigida em todas as operações | | Token de acesso (Bearer) | Token cifrado de autenticação |

Indice

• Opens-Contacts
  • Prerequisitos
  • Indice
  • Instalação
  • Métodos
    • Autenticar usuário
      • Exemplo
    • Encontrar ou criar contato
  • Caso de uso

.

Instalação

Para instalar a biblioteca, execute o comando:

$ npm install -S @opens/contacts

Métodos

Autenticar usuário

Essa função autentica um usuário presente do yunique e retorna um token de validação. A validação pode ser feita usando uma combinação de email e senha, ou usando a chave de API que cada usuário pode gerar através do Yunique.

Exemplo

const { authenticate } = require("./dist")

const authToken = authenticate({email: "[email protected]", password: "yunique!"})

OU

const { authenticate } = require("./dist")

const authToken = authenticate({apiToken:"minha-chave-de-autenticação"})

O parametro authToken nada mais é do que o token de usuário autenticado de um usuário. A autenticação de um usuário pode ser feita usando o método authenticate, presente nesse mesmo pacote.

Encontrar ou criar contato

Ao ser chamada, essa função cria ou encontra um contato correspondente aos parametros fornecidos

const { findOrCreateContact } = require('@opens/contacts')
const contact = await findOrCreateContact({ contactName, phoneNumber, companyId }, authToken)

O parametro authToken nada mais é do que o token de usuário autenticado de um usuário. A autenticação de um usuário pode ser feita usando o método authenticate, presente nesse mesmo pacote.

Caso de uso

Essa SDK nada mais é do que um empacotamento de nossas APIs. É possivel combinar esses dois metodos para embarcar partes do yunique na sua própria página web.

Ao substituir os valores dos campos ${apiToken} e ${contact.id} presentes no campo src do iframe a cima ( cujo tamanho pode ser contralado pela sua própria aplicação ) sera aberto uma pagina do yunique para que um novo bate-papo seja iniciado com esse contato.