Por Yeastar
Yestar Document Center



Ao integrar o Linkus SDK da Yeastar em um aplicativo de terceiros (Android ou iOS), o sistema substitui o mecanismo de push nativo do aplicativo Linkus pelo mecanismo de push da sua própria aplicação [1]. Se os certificados push não forem configurados no painel do Yeastar, os smartphones deixarão de receber notificações de chamadas recebidas.

Este guia detalha o passo a passo para obter e configurar os certificados para as três plataformas mais comuns: iOS APNS Push, Android Google Firebase Push e Android Getui Push.

1. Android Google Firebase Push (FCM)

O Firebase Cloud Messaging (FCM) é o padrão para envio de notificações push na maioria dos dispositivos Android globais.

Como obter o certificado

Para configurar esta opção, você precisa gerar um arquivo `.json` contendo as credenciais da conta de serviço do seu projeto no Firebase.

  • a. Acesse o [Firebase Console](https://console.firebase.google.com) e faça login com sua conta Google.
  • b. Selecione o projeto correspondente ao seu aplicativo Android.
  • c. No menu lateral esquerdo, clique no ícone de engrenagem (Configurações) ao lado de "Visão geral do projeto" e selecione Configurações do projeto.
  • d. Acesse a aba Contas de serviço.
  • e. *Nota:* Ignore as opções de "Snippet de configuração do SDK Admin" (Node.js, Java, Python, Go). Essas opções são apenas exemplos de código e não são necessárias para o Yeastar.
  • f. Role até o final da página e clique no botão azul Gerar nova chave privada.
  • g. Confirme a ação no aviso que aparecer. O download de um arquivo `.json` será iniciado automaticamente.

Como configurar no Yeastar

  • a. Acesse o painel do Yeastar P-Series Cloud Edition.
  • b. Navegue até Integração > Linkus SDK.
  • c. Na seção Certificado Push, clique em Adicionar.
  • d. Selecione a plataforma: Android Google Firebase Push.
  • e. Clique em Procurar e faça o upload do arquivo `.json` que você acabou de baixar.
  • f. Clique em Salvar.

2. Android Getui Push (Engagelab)

O Getui (oferecido pela Engagelab) é um serviço alternativo de push, frequentemente utilizado para garantir a entrega de notificações em dispositivos Android que não possuem o Google Play Services (como alguns modelos Huawei, Xiaomi, etc.).

Como obter as credenciais

Você precisará criar um aplicativo na plataforma AppPush da Engagelab e extrair três informações essenciais: `App ID`, `App Key` e `Master Secret`.

  • a. Acesse a plataforma [Engagelab Console](https://www.engagelab.com/console) e faça login.
  • b. No menu lateral, acesse AppPush Apps > App Management e clique em Create App.
  • c. Passo 1 — Platform Configuration: Preencha as informações básicas, prestando muita atenção ao Package Name do seu aplicativo Android (ex: `com.suaempresa.seuapp`). *Atenção: O Package Name não pode ser alterado após a configuração.*
  • d. Os Passos 2 (Channel Configuration), 3 e 4 são opcionais ou voltados para desenvolvedores, e não são necessários para obter as credenciais do Yeastar.
  • e. Após criar o app, volte para a tela App Management e clique em Enter na linha do seu aplicativo.
  • f. No menu lateral do aplicativo, vá em Basic Settings > App Info.
  • g. Nesta tela, você encontrará o AppKey e o Master Secret.
  • h. Para encontrar o App ID: Observe a URL do seu navegador. O App ID é o código alfanumérico que aparece logo após `/#/app-push/` e antes da próxima barra. (Exemplo: na URL `.../#/app-push/6a3fd566b9202715acbcc62f/d7623ce...`, o App ID é `6a3fd566b9202715acbcc62f`).

Como configurar no Yeastar

  • a. No painel do Yeastar, vá em Integração > Linkus SDK > Certificado Push > Adicionar.
  • b. Selecione a plataforma: Android Getui Push.
  • c. Preencha os campos com os dados obtidos no Engagelab:

    - App ID: O código extraído da URL.
    - App Key: O valor copiado da tela App Info.
    - Master Secret: O valor copiado da tela App Info.
  • d. Clique em Salvar.

3. iOS APNS Push (Apple)

Para dispositivos Apple (iPhones e iPads), é obrigatório o uso do Apple Push Notification service (APNs).

Como obter o certificado

Você precisará de uma conta ativa ($99,00 por ano) no Apple Developer Program.

  • a. Acesse [developer.apple.com](https://developer.apple.com).
  • b. Clique no ícone de perfil no canto superior direito e faça login com seu Apple ID.
  • c. Acesse diretamente a URL [developer.apple.com/account](https://developer.apple.com/account).
  • d. No menu lateral esquerdo, clique em Certificates, Identifiers & Profiles.
  • e. No menu lateral, selecione Keys.
  • f. Clique no botão + (Create a key) para gerar uma nova chave.
  • g. Dê um nome descritivo à chave (ex: `Yeastar Linkus Push`).
  • h. Marque a caixa de seleção Apple Push Notifications service (APNs).
  • i. Clique em Continue e depois em Register.
  • h. Na tela de confirmação, clique em Download para baixar o arquivo `.p8`. *Atenção: Este arquivo só pode ser baixado uma vez. Guarde-o em um local seguro.*
  • k. Anote o Key ID (código de 10 caracteres exibido na mesma tela de download).
  • l. Anote o Team ID (código de 10 caracteres visível no canto superior direito do portal, sob o seu nome).

Como configurar no Yeastar

  • a. No painel do Yeastar, vá em Integração > Linkus SDK > Certificado Push > Adicionar.
  • b. Selecione a plataforma: iOS APNS Push.
  • c. Preencha os campos:
    - Key ID: O código de 10 caracteres da chave gerada.
    - Team ID: O código de 10 caracteres da sua conta Apple Developer.
    - Topic: O Bundle ID do seu aplicativo iOS (ex: `com.suaempresa.seuapp`).
    - TopicVoip: O Bundle ID do seu aplicativo acrescido do sufixo `.voip` (ex: `com.suaempresa.seuapp.voip`).
    - Arquivo de certificado: Faça o upload do arquivo `.p8` baixado.
  • d. Clique em Salvar.

Considerações Finais

* É possível cadastrar múltiplos certificados no Yeastar (um para cada plataforma que seu aplicativo suporta).
* Verifique se o seu PBX atende aos requisitos mínimos: Firmware 84.12.0.32 ou superior e Plano Ultimate (UP) [1].
* Após salvar as configurações, o Yeastar passará a enviar as notificações de chamadas recebidas através dos canais configurados, restabelecendo o funcionamento do push nos smartphones.

Referências

[1] Yeastar P-Series Cloud Edition. Enable Linkus SDK and Bind Push Certificate. Disponível em: https://help.yeastar.com/en/p-series-linkus-cloud-edition/linkus-sdk-guide/enable-linkus-sdk-for-android-and-bind-push-certificate.html