SDKs e REST APIs

  • Artigo
  • 4 minutos para ler

Azure Communication Services capacidades são organizadas conceptualmente em áreas discretas com base na sua área funcional. A maioria das áreas tem SDKs de origem totalmente aberta programados contra APIs de REST publicados que você pode usar diretamente através da Internet. O Call SDK utiliza interfaces de rede proprietárias e é de origem fechada.

Nas tabelas abaixo resumimos estas áreas e disponibilidade de APIs REST e bibliotecas SDK. Notamos se as APIs e SDKs se destinam a clientes de utilizador final ou ambientes de serviço confiáveis. As APIs, como o SMS, não devem ser diretamente acedidas por dispositivos de utilizador final em ambientes de baixa confiança.

O desenvolvimento de aplicações call and chat pode ser acelerado pela biblioteca de UI Azure Communication Services. A biblioteca de UI personalizável fornece componentes de UI de código aberto para aplicações Web e móveis, e um tema Microsoft Teams.

SDKs

Assemblagem Protocolos Ambiente Capacidades
Azure Resource Manager REST Serviço Fornecimento e gestão dos recursos dos Serviços de Comunicação
Common N/D Serviço ao Cliente & Fornece tipos de base para outros SDKs
Identidade REST Serviço Gerir utilizadores, aceder a fichas
Números de telefone REST Serviço Adquirir e gerir números de telefone
SMS REST Serviço Enviar e receber mensagens SMS
E-mail REST Serviço Enviar e obter o estado em Email mensagens
Chat DESCANSE COM sinalização proprietária Serviço ao Cliente & Adicione chat de texto em tempo real às suas aplicações
Chamando Transporte proprietário Cliente Voz, vídeo, partilha de ecrãs e outras comunicações em tempo real
Chamada Automation REST Serviço Construa fluxos de trabalho de chamadas personalizados para chamadas PSTN e VoIP
Rede Traversal REST Serviço Aceder a servidores TURN para transporte de dados de baixo nível
Biblioteca UI N/D Cliente Componentes de UI prontos para produção para apps de chat e chamadas

Idiomas e locais de publicação

As localizações de publicação de pacotes SDK individuais são detalhadas abaixo.

Área JavaScript .NET Python Java SE iOS Android Outros
Azure Resource Manager npm NuGet PyPi Maven - - Ir via GitHub
Common npm NuGet N/D Maven GitHub Maven -
Identidade npm NuGet PyPi Maven - - -
Números de telefone npm NuGet PyPi Maven - - -
Chat npm NuGet PyPi Maven GitHub Maven -
SMS npm NuGet PyPi Maven - - -
E-mail npm NuGet PyPi Maven - - -
Chamando npm NuGet - - GitHub Maven -
Chamada Automation NuGet Maven
Rede Traversal npm NuGet PyPi Maven - - -
Biblioteca UI npm - - - GitHub GitHub GitHub, Storybook
Documentação de Referência docs docs - docs docs docs -

Detalhes de suporte da plataforma SDK

iOS e Android

  • Serviços de Comunicação iOS SDKs visam a versão 13+, e Xcode 11+.
  • Android Java SDKs alvo Android API nível 21+ e Android Studio 4.0+

.NET

Com exceção da chamada, os pacotes de serviços de comunicação visam .NET Standard 2.0, que suporta as plataformas listadas abaixo.

Apoio via .NET Framework 4.6.1

  • Windows 10, 8.1, 8 e 7
  • Windows Server 2012 R2, 2012 e 2008 R2 SP1

Suporte via .NET Core 2.0:

  • Windows 10 (1607+), 7 SP1+, 8.1
  • Windows Server 2008 R2 SP1+
  • Max OS X 10.12+
  • Versões/distribuições linux
  • UWP 10.0.16299 (RS3) setembro 2017
  • Unidade 2018.1
  • Mono 5.4
  • Xamarin iOS 10.14
  • Xamarin Mac 3.8

O pacote Calling suporta aplicações UWP construídas com .NET Native ou C++/WinRT em:

  • Windows 10 10.0.17763
  • Windows Server 2019 10.0.17763

APIs REST

As APIs dos Serviços de Comunicação são documentadas juntamente com outras APIs de REPOUSO Azure. Esta documentação irá dizer-lhe como estruturar as suas mensagens HTTP e oferece orientações para a utilização do Carteiro. A documentação da interface REST também é publicada em formato Swagger no GitHub. Pode encontrar limites de estrangulamento para APIs individuais na página de limites de serviço.

Expectativas de estabilidade da API

Importante

Esta secção fornece orientações sobre APIs rest e SDKs marcados estáveis. APIs marcados pré-lançamento, pré-visualização ou beta podem ser alterados ou depreciados sem aviso prévio.

No futuro, poderemos retirar as versões dos SDKs dos Serviços de Comunicação, e podemos introduzir alterações de rutura nas nossas APIs de REST e SDKs lançados. Azure Communication Services seguirão geralmente duas políticas de apoio para a retirada das versões de serviço:

  • Será notificado pelo menos três anos antes de ser obrigado a alterar o código devido a uma alteração da interface dos Serviços de Comunicação. Todas as APIs de REST documentadas e APIs SDK geralmente gozam de pelo menos três anos de aviso antes de as interfaces serem desativadas.
  • Será notificado pelo menos um ano antes de ter de atualizar os conjuntos SDK para a versão menor mais recente. Estas atualizações necessárias não devem exigir alterações de código porque estão na mesma versão principal. A utilização dos SDK mais recentes é especialmente importante para as bibliotecas Call and Chat que os componentes em tempo real que muitas vezes requerem atualizações de segurança e desempenho. Encorajamo-lo vivamente a manter todos os seus SDKs de Serviços de Comunicação atualizados.

Exemplos de desmantelamento da API e da SDK

Integrou a versão v24 da API SMS REST na sua aplicação. A Azure Communication lança v25.

Receberá três anos de aviso antes que estas APIs parem de funcionar e sejam obrigadas a atualizar para v25. Esta atualização pode requerer uma alteração de código.

Integrou a versão v2.02 do Call SDK na sua aplicação. A Azure Communication lança v2.05.

Poderá ser necessário atualizar para a versão v2.05 do Call SDK no prazo de 12 meses após o lançamento do v2.05. Esta deve ser uma simples substituição do artefacto sem exigir uma alteração de código porque o v2.05 está na versão principal v2 e não tem alterações de rutura.

Passos seguintes

Para mais informações, consulte as seguintes sínteses da SDK:

Para começar com Azure Communication Services: