Auf dieser Seite:

Dadurch, dass Hipchat Server in Ihrem Hause installiert werden kann, unterscheidet sich die Konnektivität mit Ihrer Integration im Vergleich zur Cloud Version von Hipchat (*.stride.com).

Dieser Guide führt Sie durch die Konfiguration, die nötig ist damit Ihre Integration mit Hipchat Server kompatibel wird.

Machen Sie Ihre Integration mit Hipchat Server kompatibel

Vorschriften für Add-ons (API V1)

Beschränken Sie nicht den Hipchat API Endpunkt (https://api.hipchat.com/v1/rooms/message) in Ihrer Implementierung, sondern erlauben Sie den Benutzern bei der Konfiguration der Integration folgendes zu spezifizieren:

• Die API Base-URL und den Token, oder
• die ganze API-URL, inklusive Token.

Zum Beispiel:

https://my.hipch.at/v1/rooms/message?format=json&auth_token={token}

Vorschriften für Add-ons (API V2)

Beschränken Sie nicht den Hipchat API Endpunkt (https://api.hipchat.com/) in Ihrer Implementierung, sondern erlauben Sie den Benutzern bei der Konfiguration der Integration folgendes zu spezifizieren:

• Die API Base-URL und den Token, oder
• die vollständige API-URL, inklusive Token. Die Hipchat Adminoberfläche wird bald nur das Copy & Pasten der URLs erlauben, also ist das der empfohlene Ansatz.

Zum Beispiel:

https://my.hipch.at/v2/room/{id_or_name}/notification?auth_token={token}

Verbinden Sie die Add-ons

Behalten Sie im Hinterkopf, dass die ein- und ausgehenden Verbindungen nicht für Installationen auf dem Hipchat Server gewährt werden. Ihr Add-on könnte möglicherweise nicht in der Lage sein Nachrichten an Hipchat zu senden und welche zu erhalten.

Sie müssen außerdem ältere Versionen von Hipchat Server unterstützen (oder zumindest auf eine Weise berücksichtigen).

Die Regel Nummer eins lautet: Überprüfen Sie Ihre Implementierung mit dem Hipchat Capability Document. Wenn Sie das Atlassian Connect Framework verwenden, dann wird Ihnen dieses abgenommen. Falls Sie aber ein Add-on implementieren ohne das Atlassian Framework zu verwenden, dann folgen Sie bitte diesem Ansatz:

Wenn ein Add-on in Hipchat installiert wird, wird Ihr Add-on Dienst mit einem Link im Hipchat Capability Document erwähnt.

Das sieht folgendermaßen aus:

A. Sie spezifizieren den Endpunkt, der die Installation in Ihrem Capability Descriptor handhabt:

"installable": {
  "callbackUrl": "https://example.com/myaddon/installable"
}

B. Hipchat ruft diese URL mit dem Installations-Payload auf:

{
  "capabilitiesUrl": "https://my.hipch.at/v2/capabilities",
  "oauthId:" "...",
  "oauthSecret": "..."
}

C. Sie können das Capabilities Document erhalten, zu dem Hipchat Sie verweist. Das sieht wie folgt aus:

{
    "capabilities": {
        "hipchatApiProvider": {
            "availableScopes": {
              ...
            },
            "url": "https://my.hipch.at/v2"
        },
        "oauth2Provider": {
            "authorizationUrl": "https://my.hipch.at/users/authorize",
            "tokenUrl": "https://my.hipch.at/v2/oauth/token"
        }
    },
    "description": "Group chat and IM built for teams",
    "key": "hipchat",
    "links": {
        "api": "https://my.hipch.at/v2",
        "homepage": "https://www.hipchat.com",
        "self": "https://my.hipch.at/v2/capabilities"
    },
    "name": "HipChat",
    "vendor": {
        "name": "Atlassian",
        "url": "http://atlassian.com"
    }
}

D. Danach entnehmen Sie die URLs, die Sie zum Aufrufen der API und zum Validieren der Installation, wie hier beschrieben (auf Englisch), benötigen.

apiEndpoint = doc['capabilities']['hipchatApiProvider']['url']
authorizationUrl = doc['capabilities']['oauth2Provider']['authorizationUrl']
tokenUrl = doc['capabilities']['oauth2Provider']['tokenUrl']

Wenn Sie diese Schritte befolgen, müssen Sie keine Vermutungen darüber aufstellen wo die Hipchat-API sich befindet und wenn eine dieser URLs jemals an einen anderen Endpunkt verweisen sollte, wird Ihr Add-on trotzdem funktionieren.

Markieren Sie eine Verbindung als mit Hipchat Server kompatibel

Standardmäßig werden Hipchat Add-ons in Atlassians Marketplace nicht auch für Hipchat Server angezeigt. Benachrichtigen Sie Atlassian darüber, dass Ihr Add-on bei der nächsten Version auch für Hipchat Server kompatibel sein wird und die entsprechende Markierung werden für Sie eingetragen.

Änderungen an der Dokumentation

Wenn Sie Ihre Integration mit Hipchat Server kompatibel machen, aktualisieren Sie bitte auch die dazugehörigen Installationsanleitungen.

Listen Sie die Verbindungs-Anforderungen für Ihre Integration auf:

• Hipchats eingehende Verbindungs-Anforderungen: Wenn Ihre Integration die Hipchat APIs verwendet.
• Hipchats ausgehende Verbindungs-Anforderungen: Wenn Ihre Integration Webhooks verwendet (stellen Sie sicher die Hosts und Ports aufzuführen).