Skip to main content

Glossar of the Developer Portal

TermsDescription
Access KeyAn access key is a token that a customer provides for API calls.
Access TokenAn access token receives all security data for the authentication of an API and identifies the user, the user groups and the user's authorizations.
Activation RequestAn activation request is made by the customer when they request the use of an API from the provider. It is designed to ensure smooth and efficient access to our services.
ProvidersProviders are all organizations that provide API products on the Developer Portal.
APIAn application programming interface, often referred to as an API for short, is a program part that is made available by a software system to other programs for connection to the system.
API ProductsThis term is used when several APIs are involved (see API above).
AppAn App describes a collection of API products that are brought together by the customer in an application. By registering API products to an App, the customer can use the services offered by these API products using the stored authentication means. By using Apps, customers can bundle their access to multiple API products, manage the authentication means and establish a contractual relationship with the provider.
Authentication MethodDescribes the procedure required to use an API in order to exchange the information required for the authentication of an API between provider and customer. For this purpose, the Developer Portal supports authentication methods that were stored when an API was created.
Authentication MeansA concrete authentication means of the customer. The customer owns and controls it and it is used to authenticate the customer's identity (e.g. access token).
AuthorizationsThe authorizations of a user to use API products.
Business CaseSpecification of value creation, use case and traffic when describing a customer's App in order to provide the provider with a rough concept of the application.
FileDigital document for the customer's information that a provider can store in its API for the customer (e.g. API explorer, readme).
DocumentationSum of the files stored at an API.
ApprovalA approval can be carried out by the provider after an activation request. The approval guarantees use of an API by the customer.
Hash-processHashing is a cryptographic method that converts data records and characters of any length into compact, fixed hash values.
Contact PersonCustomer of API products must store a contact person in the Developer Portal in order to provide the provider with a direct contact person.
CustomersCustomers are all organizations that use API products from the Developer Portal.
Manual HandoverAuthentication method that can be used if no handover method of the authenticator has been stored in the API. This means that the exchange of authentication information is regulated individually between provider and customer.
MarketplaceThe Marketplace is a main page in the Developer Portal where you can find all of our providers' API products.
UsersUsers are all persons or systems (technical users) who have an account in the Developer Portal.
FolderA grouped collection of files in the documentation of an API.
OrganizationA company that is represented on the Developer Portal and offers or uses API products.
Organization DataAll information that organizations must provide about themselves in the Developer Portal.
PlanThe plan describes the extent to which an API can be used when connecting Apps and API products.
ReadmeA file that describes how an API can be used.
Refresh TokenA refresh token makes it possible to obtain a new access token without prompting the user.
TeamTeams represent user groups of the provider or customer. Teams are used to grant or restrict access to certain resources.
Technical UserUser who accesses functions via the Developer Portal API. A technical user is assigned to an organization and is not directly linked to a natural user.