Utilisation de Notification Hubs à partir de Python

Article
06/01/2023

Vous pouvez accéder à toutes les fonctionnalités Notification Hubs à partir d'un serveur principal Java/PHP/Python/Ruby en utilisant l'interface REST Notification Hub, comme décrit dans l’article MSDN API REST Notification Hubs.

Notes

Ceci est un exemple d’implémentation de référence pour l’implémentation des envois de notifications dans Python. Il ne s’agit pas du Kit de développement logiciel (SDK) de Notification Hub Python officiellement pris en charge. L’exemple a été créé à l’aide de Python 3.4.

Cet article vous montre comment :

créer un client REST pour les fonctionnalités de Notification Hubs dans Python ;
envoyer des notifications à l’aide de l’interface de Python vers les API REST Notification Hub ;
obtenir un vidage de la demande/réponse HTTP REST à des fins pédagogiques/de débogage.

Vous pouvez suivre le didacticiel de prise en main pour la plateforme mobile de votre choix, en implémentant la partie concernant le serveur principal dans Python.

Notes

L’étendue de l’exemple est limitée uniquement à l’envoi de notifications et il n’effectue aucune gestion des inscriptions.

Interface client

L'interface client principale peut fournir les mêmes méthodes que celles disponibles dans le Kit de développement logiciel (SDK) .NET Notification Hubs. Cette interface vous permet de traduire directement les tutoriels et les exemples actuellement disponibles sur ce site et fournis par la communauté sur Internet.

Tout le code est disponible dans l' exemple de wrapper REST Python.

Par exemple, pour créer un client :

isDebug = True
hub = NotificationHub("myConnectionString", "myNotificationHubName", isDebug)

Pour envoyer une notification toast de Windows :

wns_payload = """<toast><visual><binding template=\"ToastText01\"><text id=\"1\">Hello world!</text></binding></visual></toast>"""
hub.send_windows_notification(wns_payload)

Implémentation

Si ce n’est déjà fait, suivez le didacticiel de prise en main jusqu’à la dernière section, dans laquelle vous devrez implémenter le serveur principal.

Tous les détails de l'implémentation d'un wrapper REST complet se trouvent sur MSDN. Cette section décrit l’implémentation Python des principales étapes requises pour accéder aux points de terminaison REST de Notification Hubs et envoyer des notifications :

Analyse de la chaîne de connexion
Génération du jeton d'autorisation
Envoyer une notification à l’aide de l’API REST de HTTP

Analyse de la chaîne de connexion

Voici la classe principale implémentant le client, dont le constructeur analyse la chaîne de connexion :

class NotificationHub:
    API_VERSION = "?api-version=2013-10"
    DEBUG_SEND = "&test"

    def __init__(self, connection_string=None, hub_name=None, debug=0):
        self.HubName = hub_name
        self.Debug = debug

        # Parse connection string
        parts = connection_string.split(';')
        if len(parts) != 3:
            raise Exception("Invalid ConnectionString.")

        for part in parts:
            if part.startswith('Endpoint'):
                self.Endpoint = 'https' + part[11:].lower()
            if part.startswith('SharedAccessKeyName'):
                self.SasKeyName = part[20:]
            if part.startswith('SharedAccessKey'):
                self.SasKeyValue = part[16:]

Création du jeton de sécurité

Les détails concernant la création d'un jeton de sécurité sont disponibles ici. Ajoutez les méthodes suivantes à la classe NotificationHub pour créer le jeton à partir de l’URI de la demande actuelle et des informations d’identification extraites de la chaîne de connexion.

@staticmethod
def get_expiry():
    # By default returns an expiration of 5 minutes (=300 seconds) from now
    return int(round(time.time() + 300))


@staticmethod
def encode_base64(data):
    return base64.b64encode(data)


def sign_string(self, to_sign):
    key = self.SasKeyValue.encode('utf-8')
    to_sign = to_sign.encode('utf-8')
    signed_hmac_sha256 = hmac.HMAC(key, to_sign, hashlib.sha256)
    digest = signed_hmac_sha256.digest()
    encoded_digest = self.encode_base64(digest)
    return encoded_digest


def generate_sas_token(self):
    target_uri = self.Endpoint + self.HubName
    my_uri = urllib.parse.quote(target_uri, '').lower()
    expiry = str(self.get_expiry())
    to_sign = my_uri + '\n' + expiry
    signature = urllib.parse.quote(self.sign_string(to_sign))
    auth_format = 'SharedAccessSignature sig={0}&se={1}&skn={2}&sr={3}'
    sas_token = auth_format.format(signature, expiry, self.SasKeyName, my_uri)
    return sas_token

Envoyer une notification à l’aide de l’API REST de HTTP

Notes

Le Service de notifications push Microsoft (MPNS) est obsolète et n’est plus pris en charge.

Commençons par définir une classe représentant une notification.

class Notification:
    def __init__(self, notification_format=None, payload=None, debug=0):
        valid_formats = ['template', 'apple', 'gcm',
                         'windows', 'windowsphone', "adm", "baidu"]
        if not any(x in notification_format for x in valid_formats):
            raise Exception(
                "Invalid Notification format. " +
                "Must be one of the following - 'template', 'apple', 'gcm', 'windows', 'windowsphone', 'adm', 'baidu'")

        self.format = notification_format
        self.payload = payload

        # array with keynames for headers
        # Note: Some headers are mandatory: Windows: X-WNS-Type, WindowsPhone: X-NotificationType
        # Note: For Apple you can set Expiry with header: ServiceBusNotification-ApnsExpiry
        # in W3C DTF, YYYY-MM-DDThh:mmTZD (for example, 1997-07-16T19:20+01:00).
        self.headers = None

Cette classe est un conteneur pour un corps de notification natif ou un ensemble de propriétés dans le cas d’un modèle de notification, et un ensemble d’en-têtes contenant le format (plateforme native ou modèle) et des propriétés spécifiques de la plateforme (telles que la propriété d’expiration d’Apple et les en-têtes WNS).

Pour connaître toutes les options disponibles, consultez la documentation sur les API REST de Notification Hubs et les formats spécifiques des plateformes de notification.

Avec cette classe, écrivez les méthodes d’envoi des notifications à l’intérieur de la classe NotificationHub.

def make_http_request(self, url, payload, headers):
    parsed_url = urllib.parse.urlparse(url)
    connection = http.client.HTTPSConnection(
        parsed_url.hostname, parsed_url.port)

    if self.Debug > 0:
        connection.set_debuglevel(self.Debug)
        # adding this querystring parameter gets detailed information about the PNS send notification outcome
        url += self.DEBUG_SEND
        print("--- REQUEST ---")
        print("URI: " + url)
        print("Headers: " + json.dumps(headers, sort_keys=True,
                                       indent=4, separators=(' ', ': ')))
        print("--- END REQUEST ---\n")

    connection.request('POST', url, payload, headers)
    response = connection.getresponse()

    if self.Debug > 0:
        # print out detailed response information for debugging purpose
        print("\n\n--- RESPONSE ---")
        print(str(response.status) + " " + response.reason)
        print(response.msg)
        print(response.read())
        print("--- END RESPONSE ---")

    elif response.status != 201:
        # Successful outcome of send message is HTTP 201 - Created
        raise Exception(
            "Error sending notification. Received HTTP code " + str(response.status) + " " + response.reason)

    connection.close()


def send_notification(self, notification, tag_or_tag_expression=None):
    url = self.Endpoint + self.HubName + '/messages' + self.API_VERSION

    json_platforms = ['template', 'apple', 'gcm', 'adm', 'baidu']

    if any(x in notification.format for x in json_platforms):
        content_type = "application/json"
        payload_to_send = json.dumps(notification.payload)
    else:
        content_type = "application/xml"
        payload_to_send = notification.payload

    headers = {
        'Content-type': content_type,
        'Authorization': self.generate_sas_token(),
        'ServiceBusNotification-Format': notification.format
    }

    if isinstance(tag_or_tag_expression, set):
        tag_list = ' || '.join(tag_or_tag_expression)
    else:
        tag_list = tag_or_tag_expression

    # add the tags/tag expressions to the headers collection
    if tag_list != "":
        headers.update({'ServiceBusNotification-Tags': tag_list})

    # add any custom headers to the headers collection that the user may have added
    if notification.headers is not None:
        headers.update(notification.headers)

    self.make_http_request(url, payload_to_send, headers)


def send_apple_notification(self, payload, tags=""):
    nh = Notification("apple", payload)
    self.send_notification(nh, tags)


def send_google_notification(self, payload, tags=""):
    nh = Notification("gcm", payload)
    self.send_notification(nh, tags)


def send_adm_notification(self, payload, tags=""):
    nh = Notification("adm", payload)
    self.send_notification(nh, tags)


def send_baidu_notification(self, payload, tags=""):
    nh = Notification("baidu", payload)
    self.send_notification(nh, tags)


def send_mpns_notification(self, payload, tags=""):
    nh = Notification("windowsphone", payload)

    if "<wp:Toast>" in payload:
        nh.headers = {'X-WindowsPhone-Target': 'toast',
                      'X-NotificationClass': '2'}
    elif "<wp:Tile>" in payload:
        nh.headers = {'X-WindowsPhone-Target': 'tile',
                      'X-NotificationClass': '1'}

    self.send_notification(nh, tags)


def send_windows_notification(self, payload, tags=""):
    nh = Notification("windows", payload)

    if "<toast>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/toast'}
    elif "<tile>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/tile'}
    elif "<badge>" in payload:
        nh.headers = {'X-WNS-Type': 'wns/badge'}

    self.send_notification(nh, tags)


def send_template_notification(self, properties, tags=""):
    nh = Notification("template", properties)
    self.send_notification(nh, tags)

Ces méthodes envoient une demande POST HTTP au point de terminaison /messages de votre hub de notification, avec le corps et les en-têtes corrects pour envoyer la notification.

Utilisation de la propriété debug pour activer la journalisation détaillée

L’activation de la propriété debug lors de l’initialisation du hub de notification permet de rédiger des informations de journalisation détaillées sur le vidage des requêtes et réponses HTTP, ainsi que le résultat détaillé de l’envoi des messages de notification. La propriété TestSend Notification Hubs retourne des informations détaillées sur le résultat de l'envoi de notification. Pour l’utiliser, réalisez une initialisation à l’aide du code suivant :

hub = NotificationHub("myConnectionString", "myNotificationHubName", isDebug)

L’URL HTTP de demande d’envoi de hub de notification est ajoutée avec une chaîne de requête « test ».

Suivi du didacticiel

Vous pouvez à présent terminer le didacticiel de prise en main en envoyant la notification à partir d’un serveur principal Python.

Initialisez votre client Notification Hubs (remplacez la chaîne de connexion et le nom du concentrateur comme indiqué dans le didacticiel de prise en main) :

hub = NotificationHub("myConnectionString", "myNotificationHubName")

Ajoutez ensuite le code d'envoi en fonction de la plateforme mobile cible. Cet exemple ajoute également des méthodes de plus haut niveau pour activer l’envoi de notifications basées sur la plateforme, par exemple send_windows_notification pour Windows, send_apple_notification (pour Apple), etc.

Windows Store et Windows Phone 8.1 (non-Silverlight)

wns_payload = """<toast><visual><binding template=\"ToastText01\"><text id=\"1\">Test</text></binding></visual></toast>"""
hub.send_windows_notification(wns_payload)

Windows Phone 8.0 et 8.1 Silverlight

hub.send_mpns_notification(toast)

iOS

alert_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_apple_notification(alert_payload)

Android

gcm_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_google_notification(gcm_payload)

Kindle Fire

adm_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_adm_notification(adm_payload)

Baidu

baidu_payload = {
    'data':
        {
            'msg': 'Hello!'
        }
}
hub.send_baidu_notification(baidu_payload)

L’exécution de votre code Python produit normalement une notification qui apparaît sur votre appareil cible.

Exemples

Activation de la propriété `debug`

Quand vous activez l’indicateur de débogage pendant l’initialisation de la classe NotificationHub, vous voyez un vidage détaillé des requêtes et réponses HTTP ainsi que NotificationOutcome, comme suit, où vous pouvez comprendre quels en-têtes HTTP sont transmis dans la demande et quelle réponse HTTP a été reçue à partir du hub de notification :

Capture d’écran d’une console avec les détails de la sauvegarde de requête et réponse HTTP, et des messages de résultat de notification en rouge.

Vous voyez un résultat détaillé de hub de notification, par exemple

lorsque le message est envoyé au service de notification Push.

<Outcome>The Notification was successfully sent to the Push Notification System</Outcome>

Si aucune cible n’a été trouvée pour les notifications Push, vous verrez probablement les éléments suivants dans la réponse (ce qui indique qu’il n’y a eu aucun enregistrement trouvé pour fournir la notification, probablement parce que certaines balises des inscriptions ne correspondaient pas)
```
'<NotificationOutcome xmlns="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect" xmlns:i="https://www.w3.org/2001/XMLSchema-instance"><Success>0</Success><Failure>0</Failure><Results i:nil="true"/></NotificationOutcome>'
```

Notification toast de diffusion à Windows

Notez les en-têtes qui sont envoyés lorsque vous envoyez une notification toast de diffusion au client Windows.

hub.send_windows_notification(wns_payload)

Capture d’écran d’une console avec les détails de la requête HTTP et le format de notification Service Bus et les valeurs de type X W N S entourées en rouge.

Envoyer une notification indiquant une balise (ou une expression de balise)

Notez l'en-tête HTTP de balises qui est ajouté à la requête HTTP (dans l'exemple ci-dessous, la notification est uniquement envoyée aux inscriptions avec la charge utile « sports »)

hub.send_windows_notification(wns_payload, "sports")

Capture d’écran d’une console avec les détails de la requête HTTP et le format de notification Service Bus, une balise de notification Service Bus et les valeurs de type XWNS entourées en rouge.

Envoyer une notification spécifiant plusieurs balises

Notez comment l’en-tête HTTP des balises change lorsque plusieurs balises sont envoyées.

tags = {'sports', 'politics'}
hub.send_windows_notification(wns_payload, tags)

Capture d’écran d’une console avec les détails de la requête HTTP et le format de notification Service Bus, plusieurs balises de notification Service Bus et les valeurs de type XWNS entourées en rouge.

Notification avec modèle

Notez que l’en-tête HTTP de format change et que le corps de charge utile est envoyé en tant que partie intégrante du corps de requête HTTP :

Côté client - modèle enregistré :

var template = @"<toast><visual><binding template=""ToastText01""><text id=""1"">$(greeting_en)</text></binding></visual></toast>";

Côté serveur - envoi de la charge utile :

template_payload = {'greeting_en': 'Hello', 'greeting_fr': 'Salut'}
hub.send_template_notification(template_payload)

Capture d’écran d’une console avec les détails de la requête HTTP et du type de contenu, et valeurs de format de notification Service Bus entourées en rouge.

Étapes suivantes

Cet article a montré comment créer un client REST Python pour Notification Hubs. À partir de là, vous pouvez :

télécharger l'intégralité de l'exemple de wrapper REST Python, qui contient tout le code de cet article ;
poursuivre l'apprentissage de la fonctionnalité de balisage de Notification Hubs dans le didacticiel Nouvelles de dernière minute
poursuivre l'apprentissage de la fonctionnalité des modèles de Notification Hubs dans le didacticiel de localisation des dernières nouvelles

Partager via

Utilisation de Notification Hubs à partir de Python

Interface client

Implémentation

Analyse de la chaîne de connexion

Création du jeton de sécurité

Envoyer une notification à l’aide de l’API REST de HTTP

Utilisation de la propriété debug pour activer la journalisation détaillée

Suivi du didacticiel

Windows Store et Windows Phone 8.1 (non-Silverlight)

Windows Phone 8.0 et 8.1 Silverlight

iOS

Android

Kindle Fire

Baidu

Exemples

Activation de la propriété `debug`

Notification toast de diffusion à Windows

Envoyer une notification indiquant une balise (ou une expression de balise)

Envoyer une notification spécifiant plusieurs balises

Notification avec modèle

Étapes suivantes

Ressources supplémentaires

Partager via

Utilisation de Notification Hubs à partir de Python

Interface client

Implémentation

Analyse de la chaîne de connexion

Création du jeton de sécurité

Envoyer une notification à l’aide de l’API REST de HTTP

Utilisation de la propriété debug pour activer la journalisation détaillée

Suivi du didacticiel

Windows Store et Windows Phone 8.1 (non-Silverlight)

Windows Phone 8.0 et 8.1 Silverlight

iOS

Android

Kindle Fire

Baidu

Exemples

Activation de la propriété debug

Notification toast de diffusion à Windows

Envoyer une notification indiquant une balise (ou une expression de balise)

Envoyer une notification spécifiant plusieurs balises

Notification avec modèle

Étapes suivantes

Ressources supplémentaires

Activation de la propriété `debug`