| Access Key | Ein Access Key ist ein Schlüssel, um auf eine API zuzugreifen. |
| Access Token | Ein Access-Token enthält alle Sicherheitsdaten für die Authentifizierung einer API und identifiziert den Benutzer, die Benutzergruppen und die Berechtigungen des Benutzers. |
| Aktivierungsanfrage | Eine Aktivierungsanfrage wird durch den Kunden gestellt, wenn dieser die Nutzung einer API beim Anbieter anfragt. Sie ist darauf ausgerichtet, einen reibungslosen und effizienten Zugang zu den Diensten des Anbieters zu gewährleisten. |
| Anbieter | Unter Anbieter sind alle Organisationen zu verstehen, die API-Produkte auf dem Developer Portal bereitstellen. |
| API | Eine Anwendungsprogrammierschnittstelle, häufig nur kurz API (engl. Application Programming Interface) genannt, ist ein Programmteil, der von einem Softwaresystem anderen Programmen zur Anbindung an das System zur Verfügung gestellt wird. |
| API-Produkte | Diese Begrifflichkeit wird verwendet, wenn es sich um mehrere APIs handelt (API siehe oben). |
| App | Eine App beschreibt eine Sammlung von API-Produkten, die von dem Kunden in einer Anwendung zusammengeführt werden. Indem API-Produkte zu einer App registriert werden, kann der Kunde die von diesen API-Produkten angebotenen Dienste mithilfe der hinterlegten Authentifizierungsmittel nutzen. Durch die Nutzung von Apps können Kunden ihren Zugriff auf mehrere API-Produkte bündeln, die Authentifizierungsmittel verwalten und eine vertragliche Beziehung zum Anbieter etablieren. |
| Authentifizierungsmethode | Beschreibt das Verfahren, das zur Nutzung einer API erforderlich ist, um die benötigte Informationen für die Authentifizierung einer API zwischen Anbieter und Kunde auszutauschen. Hierzu werden Authentifizierungsmethoen vom Developer Portal unterstützt, die bei der Anlage einer API hinterlegt wurden. |
| Authentifizierungsmittel | Ein konkreter Authentifikator des Kunden. Der Kunde besitzt und kontrolliert es und es wird zur Authentifizierung der Identität des Kunden verwendet (wie z.B. Access-Token). |
| Berechtigungen | Die Berechtigungen eines Nutzers zur Nutzung von API-Produkten. |
| Business Case | Angabe von Wertschöpfung, Use-Case und Traffic bei der Beschreibung einer App des Kunden, um dem Anbieter ein Grobkonzept über die Verwendung der API-Produkte zu liefern. |
| Datei | Digitales Dokument zur Information des Kunden, das ein Anbieter an seiner API für den Kunden hinterlegen kann (z.B. API-Explorer, Readme). |
| Dokumentation | Summe der an einer API hinterlegten Dateien. |
| Freigabe | Eine Freigabe kann vom Anbieter nach einer Aktivierungsanfrage durchgeführt werden. Die Freigabe gewährleistet die Nutzung einer API durch den Kunden. |
| Hash-Verfahren | Bei Hashing handelt es sich um eine kryptografische Methode, die Datensätze und Zeichen beliebiger Länge in kompakte, feste Hashwerte verwandelt. |
| Kontaktperson | Kunden von API-Produkten müssen eine Kontaktperson im Developer Portal hinterlegen, um dem Anbieter einen direkten Ansprechpartner zu nennen. |
| Kunden | Unter Kunden sind alle Organisationen zu verstehen, die API-Produkte des Developer Portals anfragen oder nutzen. |
| Manuelle Übergabe | Authentifizierungsmethode die genutzt werden kann, wenn an der API keine Übergabemethode des Authenticators hinterlegt wurde. Das bedeutet, dass der Austausch der Authentifizierungsinformationen individuell zwischen Anbieter und Kunde geregelt wird. |
| Marktplatz | Der Marktplatz ist eine Hauptseite im Developer Portal, auf der du alle API-Produkte unserer Anbieter finden kannst. |
| Nutzer | Unter Nutzer sind alle Personen oder Systeme (technischer Nutzer) zu verstehen, die einen Account im Developer Portal besitzen. |
| Ordner | Eine gruppierte Ansammlung von Dateien bei der Dokumentation von API-Produkten oder beim Austausch von Dateien zwischen Anbieter und Kunden. |
| Organisation | Ein Unternehmen, das auf dem Developer Portal vertreten ist und API-Produkte anbietet oder nutzt. |
| Organisationsdaten | Alle Informationen, die Organisationen über sich im Developer Portal bereitstellen müssen. |
| Plan | Der Plan beschreibt, in welchem Umfang die API-Produkte genutzt werden können. |
| Readme | Eine Datei in der beschrieben wird, wie eine API genutzt werden kann. |
| Refresh-Token | Ein Refresh-Token ermöglicht es, einen neuen Access-Token für den Zugriff auf die Developer Portal-API zu erhalten. |
| Team | Teams stellen Nutzergruppen des Anbieters oder Kunden dar. Teams werden verwendet, um den Zugriff auf bestimmte Ressourcen zu gewähren oder einzuschränken. |
| Technischer Nutzer | Nutzer, der über die Developer-Portal-API auf Funktionen zugreift. Ein Technischer Nutzer ist einer Organisation zugeordnet und nicht direkt mit einem natürlichen Benutzer verbunden. |