Configuração para usar os Conectores kaizala

Personas

  • Desenvolvedor: Internamente ou terceiros desenvolvendo aplicativos para a organização – que precisam integrar a Kaizala aos processos de negócios da organização. O desenvolvedor não tem acesso ao usuário final durante o desenvolvimento do aplicativo (diferente de um Administração).
  • Administração: usuário que faz parte dos grupos finais e é administrador. Espera-se que execute tarefas de gerenciamento de grupo.
  • Usuário: Usuários finais do Kaizala

Pré-req para configurar

  • Como desenvolvedor:
    • Uma conta do Office365
    • Um número de telefone registrado em Kaizala
    • Configuração de desenvolvimento (qualquer plataforma) para invocar a API REST
  • Como administrador
    • Uma conta do Office365
    • Um número de telefone registrado em Kaizala
    • Administração de um grupo de conversa dentro de Kaizala com o número de telefone registrado
  • Como usuário
    • Um número de telefone registrado em Kaizala
    • Membro de um grupo de conversa dentro de Kaizala com o número de telefone registrado

Etapas de configuração (Administrador do Grupo de & do Desenvolvedor)

Há quatro componentes de infraestrutura importantes envolvidos no trabalho com a API da Plataforma Kaizala:

  • Conectores: Todos os sistemas de terceiros que precisam se integrar ao Kaizala precisam ser registrados com a plataforma Kaizala como um "Conector" e obter Tokens de API correspondentes ao Conector.

  • Portal de Gerenciamento do Kaizala: um portal para registrar os respectivos Conectores de terceiros e fornecer-lhes acesso a grupos de Conversa kaizala.

  • Serviço de Token: Um ponto de extremidade de URL que precisa ser chamado pelos aplicativos de terceiros para obter Tokens de Acesso.

  • Serviço de Plataforma: Um ponto de extremidade da URL que expõe recursos específicos para executar várias ações dentro do Kaizala.

  • Etapa 1: Desenvolvedor registra um Conector

    • Desenvolvedor navega até Portal de Gerenciamento do Kaizala @https://manage.kaiza.la/
    • Fazer logon usando uma conta existente do Office365
    • Registrar um número de telefone no portal tocando em "Adicionar um número de telefone"
      • Inserir número de telefone
      • Toque em "Gerar PIN"
      • Verifique o PIN recebido por meio de um SMS no número de telefone especificado
    • Toque em "Conectores" no menu esquerdo
    • Toque em "Adicionar Conector"
    • Registrar um conector para o sistema de terceiros que usará a API
      • Insira o nome do Conector e outros detalhes. Toque em Continuar
      • Selecione permissões destinadas ao Conector para ter acesso
      • Toque em Criar Conector
    • Observe a ID & Segredo que é gerado e exibido no portal
  • Etapa 2: o grupo Administração "concede" o acesso do Conector ao seu grupo

    • Administração navega até Portal de Gerenciamento do Kaizala @https://manage.kaiza.la/
    • Faça logon usando uma conta TBD do Office365 (SKU) existente
    • Registrar um número de telefone no portal tocando em "Adicionar um número de telefone"
      • Inserir número de telefone
      • Toque em "Gerar PIN"
      • Verifique o PIN recebido por meio de um SMS no número de telefone especificado
    • Toque em "Grupos" no menu à esquerda
    • Toque no nome do grupo que precisa ser acessado pelo Conector
    • Toque em "Conectores"
    • Na lista suspensa, selecione o Conector ao qual você deseja conceder acesso
    • Toque em "Adicionar Conector"
    • Observe o Token de Atualização que é gerado e exibido no portal
  • Etapa 3: o grupo Administração compartilha o Token de Atualização com o Desenvolvedor de Aplicativos

    • Administração precisa compartilhar manualmente o token de atualização recebido na Etapa 2 com o desenvolvedor do aplicativo
  • Etapa 4: Desenvolvedor de Aplicativos chama a API rest da Plataforma Kaizala para gerar Token de Acesso

    • O desenvolvedor agora pode usar o token Atualizar. uma ID do Conector e o Segredo do Conector para chamar o inorder da API REST para gerar o Token de Acesso (mais informações abaixo)

Próximo: Gerar token de acesso
Mais: Documentação da API