Mit diesem Formular können Sie fehlende, unklare oder fehlerhafte Inhalte in der Dokumentation melden und Verbesserungsvorschläge machen. Ihr Feedback hilft uns, die Qualität und Vollständigkeit kontinuierlich zu verbessern.
APIs und Schnittstellenbeschreibungen
Proxy-Infrastuktur einrichten
Die unitop Digitale Rentenübersicht Extension setzt eine Bereitstellung und Einrichtung von Azure Komponenten durch die Abteilung der GOB-Infrastruktur voraus. Dazu ist eine Azure Subscription auf Kundenseite unumgänglich. Folgende Schritte bzw. Kapitel sind daher in Kooperation mit der GOB-Infrastruktur durchzuführen.
Azure Functions Bereitstellung
In der Azure Subscription (des Kunden) muss eine Azure Function bereitgestellt werden. Legen Sie diese mit folgenden Kennzahlen an:
Do you want to deploy code or container image? Code Runtime stack .NET Version 8 (LTS) Isolated Operating System Windows Hosting Consumption (Serverless) Nach der Bereitstellung der Azure Ressource ist die aktuelle Version des Digital-Pension-Information-Proxy zu deployen. Für das Deployment steht eine ZIP-Datei im Freigabeverzeichnis zur Verfügung.
Lesen Sie dazu die vollständige Anleitung zur Bereitstellung einer Azure Function via ZIP-Deployment.
Skript zum Deployen von ZIP-Packages (Powershell)
Import-Module Az.Websites
Update-AzConfig -EnableLoginByWam $false # Aufgrund von aktuellen Bug im AZ-Modul
Connect-AzAccount -Tenant "TenantID" -Subscription "SubscriptionID"
Publish-AzWebapp -ResourceGroupName <group-name> -Name <app-name> -ArchivePath <zip-file-path>
App-Registration & Bereitstellung
Die App-Registrierung im SaaS ist obligatorisch, während sie für On-Premises optional ist. Lesen Sie hier mehr zu dem Thema Using Service to Service Authentication.
Hinweis
Die Schritte zur Einrichtung in Business Central sind zwingend zu beachten. Gleichzeitig ist die BC-Konfiguration auf on-premises Systemen entsprechend anpassen.
Azure Functions einrichten
Richten Sie die bereitgestellte Azure Function, mit dem CA-Zertifikat der ZfdR sowie einem Serverzertifikat und einigen Application-Settings, ein.
Folgende Schritte sind in der Azure Function durchzuführen:
| Settings → Certificates | |
|---|---|
| Public key certifcates (.cer) | oot- und Sub-Zertifikat der ZfdR (Download der Zertifikate, die Readme-Datei und das Kommunikationshandbuch für die Wahl der richtigen Zertifikate beachten) |
| SETTINGS → CONFIGURATION → GENERAL SETTINGS | |
|---|---|
| Client certificate mode | Require |
| SETTINGS → ENVIRONMENT VARIABLES | |
|---|---|
| Certificate:RootCaThumbprint | Der Thumbprint des vom ZfDR erhaltenen Root-Zertifikats. |
| Certificate:SubCaThumbprint | Der Fingerabdruck des vom ZfDR erhaltenen Intermediate (Sub)-Zertifikats. |
| Runtime:AuthenticationType | Basic oder OAuth (abhängig vom gewählten Authentifizierungstyp). |
| Runtime:ApplicationType | Al oder Cal (AL für BC Version > 15. Cal für BC Version 14). |
| Basic:Username | Benutzername des Business Central Servicebenutzer (nur in Kombination mit AuthenticationType: Basic). |
| Basic:Password | Passwort des Business Central Servicebenutzer (nur in Kombination mit AuthenticationType: Basic). |
| OAuth:TenantId | Tenant-ID des Kunden-Tenant (nur in Kombination mit AuthenticationType: OAuth). |
| OAuth:ClientId | Client-ID der angelegten App-Registration (nur in Kombination mit AuthenticationType: OAuth). |
| OAuth:ClientSecret | Client-Secret der angelegten App-Registration (nur in Kombination mit AuthenticationType: OAuth). |
| OAuth:ApplicationUri | SaaS: https://api.businesscentral.dynamics.com OnPrem: In der App-Registrierung definierte AnwendungsUri (nur in Kombination mit AuthenticationType: OAuth) |
| DiPInInterfaceApi:ApiUri | Saas: https://api.businesscentral.dynamics.com/v2.0/[user domain name]/[environment name]/api OnPrem: [host]:[port]/[instance]/api |
| DiPInInterfaceApi:CompanyId | BC-Company-ID |
| DiPInInterfaceApi:Tenant (optional) | z. B. default |
Serverzertifikat einrichten
- Zertifikat anfordern: Fordern Sie für den Kunden ein Serverzertifikat an. Lesen Sie hier die Anleitung dazu.
- Selbstgewählte Domain mieten: Azure App Service Domain in der eigenen Function-App
- Custom domains
- Buy App Service domain
- Gleiche Subscription und Ressourcengruppe wie Function-App, Name frei wählen, alles andere auf default einstellen
- Selbstgemietete Domain in der eigenen Function App "aktivieren":
- Custom domains
- Add custom domain
- TLS certificate: Add certificate later
- App Service Domain: die auswählen, die Sie selbst gemietet haben
- Subdomain: frei wählbar
- Restliche Einrichtungen: default (initial)
- Verbinden: Add binding
- Serverzertifikat hinzufügen: Add new certificate
- Source: upload private certificate (.pfx)
- Password: enter certificate password
- Certificate friendly name: keep default
Hinweis
Der DNS-Name im Zertifikat muss mit der "Custom domain" übereinstimmen, ein "certificate friendly name" ist für das Zertifikat nicht relevant.