Notification Hubs gebruiken vanuit Python

2025-04-09

U hebt toegang tot alle Notification Hubs-functies vanuit een Java/PHP/Python/Ruby-back-end met behulp van de Notification Hub REST-interface, zoals beschreven in het MSDN-artikel Notification Hubs REST API's.

Opmerking

Dit is een voorbeeld van een referentie-implementatie voor het implementeren van de melding die in Python wordt verzonden en is niet de officieel ondersteunde Notification Hub Python SDK. Het voorbeeld is gemaakt met Python 3.4.

In dit artikel leest u hoe u het volgende kunt doen:

Bouw een REST-client voor Notification Hubs-functies in Python.
Meldingen verzenden met behulp van de Python-interface naar de Notification Hub REST API's.
Haal een dump op van de HTTP REST-aanvraag/-reactie voor foutopsporing/educatieve doeleinden.

U kunt de zelfstudie Aan de slag volgen voor uw mobiele platform naar keuze, waarbij u het back-endgedeelte in Python implementeert.

Opmerking

Het bereik van het voorbeeld is alleen beperkt tot het verzenden van meldingen en er wordt geen registratiebeheer uitgevoerd.

Clientinterface

De belangrijkste clientinterface kan dezelfde methoden bieden die beschikbaar zijn in de .NET Notification Hubs SDK. Met deze interface kunt u alle zelfstudies en voorbeelden die momenteel beschikbaar zijn op deze site, en de bijdragen van de community op internet, rechtstreeks vertalen.

U vindt alle code die beschikbaar is in het Python REST wrapper-voorbeeld.

Als u bijvoorbeeld een client wilt maken:

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

Windows-melding verzenden:

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

Implementatie

Als u dat nog niet hebt gedaan, volgt u de zelfstudie Aan de slag tot aan de laatste sectie waar u de back-end moet implementeren.

Alle details voor het implementeren van een volledige REST-wrapper vindt u op MSDN. In deze sectie wordt de Python-implementatie beschreven van de belangrijkste stappen die nodig zijn voor toegang tot Notification Hubs REST-eindpunten en het verzenden van meldingen

De verbindingsreeks parseren
Het autorisatietoken genereren
Een melding verzenden met behulp van HTTP REST API

De verbindingsreeks parseren

Hier volgt de hoofdklasse die de client implementeert, waarvan de constructor de verbindingsreeks parseert:

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:]

Beveiligingstoken maken

De details van het maken van het beveiligingstoken zijn hier beschikbaar. Voeg de volgende methoden toe aan de NotificationHub klasse om het token te maken op basis van de URI van de huidige aanvraag en de referenties die zijn geëxtraheerd uit de verbindingsreeks.

@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

Een melding verzenden met behulp van HTTP REST API

Opmerking

Microsoft Push Notification Service (MPNS) is afgeschaft en wordt niet meer ondersteund.

Laten we eerst een klasse definiëren die een melding vertegenwoordigt.

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

Deze klasse is een container voor een natuurlijke meldingsinhoud of een set eigenschappen van een sjabloonmelding, samen met een set headers, die de indeling (natuurlijk platform of sjabloon) en platformspecifieke eigenschappen (zoals de Apple-vervaltijdseigenschap en WNS-headers) bevat.

Raadpleeg de documentatie over REST API's van Notification Hubs en de indelingen van de specifieke meldingsplatforms voor alle beschikbare opties.

Schrijf nu met deze klasse de methoden voor het verzenden van meldingen binnen de NotificationHub klasse.

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)

Met deze methoden wordt een HTTP POST-aanvraag verzonden naar het eindpunt /messages van uw Notification Hub, met de juiste hoofdtekst en headers om de melding te verzenden.

De eigenschap voor foutopsporing gebruiken om gedetailleerde logboekregistratie in te schakelen

Als u de foutopsporing inschakelt tijdens het initialiseren van de Notification Hub, worden uitgebreide logboekgegevens over de HTTP-aanvraag en antwoord-dump vastgelegd, evenals de verzendresultaten van notificatieberichten. De eigenschap Notification Hubs TestSend retourneert gedetailleerde informatie over het resultaat van het verzenden van meldingen. Gebruik deze als volgt: initialiseer deze met behulp van de volgende code:

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

De HTTP-URL voor het verzenden van aanvragen van Notification Hub krijgt als gevolg de toevoeging van een 'test'-querytekenreeks.

Voltooi de zelfstudie

U kunt nu de zelfstudie Aan de slag voltooien door de melding vanuit een Python-back-end te verzenden.

Initialiseer uw Notification Hubs-client (vervang de naam van de verbindingsreeks en de hub zoals aangegeven in de zelfstudie Aan de slag):

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

Voeg vervolgens de verzendcode toe, afhankelijk van uw mobiele doelplatform. In dit voorbeeld worden ook methoden op een hoger niveau toegevoegd om het verzenden van meldingen op basis van het platform mogelijk te maken, bijvoorbeeld send_windows_notification voor Windows; send_apple_notification (voor appel) enzovoort.

Windows Store en Windows Phone 8.1 (niet-Silverlight-versie)

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 en 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)

Als u uw Python-code uitvoert, wordt er een melding weergegeven op uw doelapparaat.

Voorbeelden

De eigenschap inschakelen `debug`

Wanneer u de vlag voor foutopsporing inschakelt tijdens het initialiseren van NotificationHub, ziet u gedetailleerde HTTP-aanvraag- en antwoorddump en NotificationOutcome, zoals hieronder, waar u kunt begrijpen welke HTTP-headers worden doorgegeven in de aanvraag en welk HTTP-antwoord is ontvangen van de Notification Hub:

Schermopname van een console met details van de H T T T P-aanvraag- en antwoorddump- en meldingsresultatenberichten die rood worden beschreven.

U ziet bijvoorbeeld een gedetailleerd Notification Hub-resultaat.

wanneer het bericht is verzonden naar de Push Notification Service.

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

Als er geen doelen zijn gevonden voor een pushmelding, ziet u waarschijnlijk de volgende uitvoer als het antwoord (wat aangeeft dat er geen registraties zijn gevonden om de melding te leveren, waarschijnlijk omdat de registraties een aantal niet-overeenkomende tags hebben)
```
'<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>'
```

Melding sturen naar Windows

Let op de kopteksten die worden verzonden wanneer u een uitzendingstoastmelding stuurt naar de Windows-client.

hub.send_windows_notification(wns_payload)

Schermopname van een console met details van de H T T P-aanvraag en de Service Bus Notification Format en X W N S Type-waarden die rood worden beschreven.

Melding verzenden waarin een tag (of tagexpressie) wordt opgegeven

Let op de Tags-header in HTTP, die wordt toegevoegd aan het HTTP-verzoek (in het onderstaande voorbeeld wordt de notificatie alleen verzonden naar registraties met de 'sport'-inhoud)

hub.send_windows_notification(wns_payload, "sports")

Schermopname van een console met details van de H T T P-aanvraag en de Service Bus Notification Format, een Service Bus Notification Tag en X W N S-typewaarden die rood worden beschreven.

Melding verzenden waarin meerdere tags worden opgegeven

U ziet hoe de HTTP-header Tags verandert wanneer meerdere tags worden verzonden.

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

Schermopname van een console met details van de H T T P-aanvraag en de Service Bus Notification Format, meerdere Service Bus Notification Tags en X W N S Type-waarden die rood worden beschreven.

Melding met sjabloon

Houd er rekening mee dat de Format-HTTP-header verandert en de payload als onderdeel van de HTTP-aanvraag wordt verzonden.

Clientzijde - geregistreerde sjabloon:

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

Serverzijde: de nettolading verzenden:

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

Schermopname van een console met details van de H T T P-aanvraag en de waarden voor inhoudstype en Service Bus Notification Format die rood worden beschreven.

Volgende stappen

In dit artikel is uitgelegd hoe u een Python REST-client voor Notification Hubs maakt. U kunt hier het volgende doen:

Download het volledige Python REST wrapper-voorbeeld, dat alle code in dit artikel bevat.
Blijf leren over de tagging functie van Notification Hubs in de Breaking News-tutorial
Lees verder over de functie Notification Hubs-sjablonen in de zelfstudie Nieuws lokaliseren

Feedback

Is deze pagina nuttig?

Delen via

Notification Hubs gebruiken vanuit Python

Clientinterface

Implementatie

De verbindingsreeks parseren

Beveiligingstoken maken

Een melding verzenden met behulp van HTTP REST API

De eigenschap voor foutopsporing gebruiken om gedetailleerde logboekregistratie in te schakelen

Voltooi de zelfstudie

Windows Store en Windows Phone 8.1 (niet-Silverlight-versie)

Windows Phone 8.0 en 8.1 Silverlight

Ios

Android

Kindle Fire

Baidu

Voorbeelden

De eigenschap inschakelen debug

Melding sturen naar Windows

Melding verzenden waarin een tag (of tagexpressie) wordt opgegeven

Melding verzenden waarin meerdere tags worden opgegeven

Melding met sjabloon

Volgende stappen

Feedback

Aanvullende resources

De eigenschap inschakelen `debug`