Verwendungsbeispiele

Gruppenlinks erstellen

Summary Group links can be shared with multiple recipients The endpoint can create multiple group links at once Required API calls: guestService.v2/createGroupLinks Request Request POST to https://apis.alfaview.com/json/v1/guestService.v2/createGroupLinks Response Notes description the title of this group […]

Join-URL mit Gruppenlink generieren

Summary Extract companyId, roomId, and accessKey from existing group link Authenticate with extracted information Assemble join url Required API calls: guestService.v2/authenticate Existing group link Request Request POST to https://apis.alfaview.com/json/v1/guestService.v2/authenticate Response Assemble join url

Gastlinks erstellen

Summary Guest links are non-shareable Guest links are for individual recipients Can create multiple guest links Optionally sends an email in the specified language (DE or EN) Required API calls: guestService.v2/createGuestLinks Request Request POST to […]

Erstauthentifizierung mit Benutzername/Passwort

Summary Creates an access token which can be used throughout the process Can be checked for expiry companyId is optional, API response contains all accessible companyIds Required API calls: authenticationService/authenticate Request Request POST to https://apis.alfaview.com/json/v1/authenticationService/authenticate […]

Erstauthentifizierung mit API Key

Summary Creates an access token which can be used throughout the process companyId is required Required API calls: authenticationService/authenticate Request Request POST to https://apis.alfaview.com/json/v1/authenticationService/authenticate Response Notes Store the access token for subsequent requests Remember to […]

Nachträgliche Authentifizierung mit Refresh Token

Summary Retrieve and store refresh token from response header of initial authentication Generate an access token from the refresh token Use access token for subsequent API operations companyId is required Required API calls: authenticationService/authenticate Step […]

Unternehmen wechseln

Summary If the initial authentication is done without the optional companyId, the authentication might log you into the wrong company (first returned accessible company will be used) In order to switch the company, simply authenticate […]

Unternehmen listen

Summary Translate the company ids from authentication response into company display names Required API calls: companyService/list Request Request POST to https://apis.alfaview.com/json/v1/companyService/list Response Notes API response for authentication request contains all company ids that are accessible […]

Räume listen

Summary Request all rooms in order to populate a dropdown menu for room selection Required API calls: roomService/list Request Request POST to https://apis.alfaview.com/json/v1/roomService/list Response Notes limit, number of results, default:100 max:1000 offset, for paging, default:0 […]

Berechtigungsgruppen listen

Summary Request all permission groups for the authenticated company Permission groups are required for other API calls (e.g. guest link creation) Required API calls: businessLogicService/permissionGroups/list Request Request POST to https://apis.alfaview.com/json/v1/businessLogicService/permissionGroups/list Response Notes The permissionGroups array […]

Räume und Abteilungen erstellen

Summary Create a room or a department anywhere in the room structure Required API calls: roomService/create Request Request POST to https://apis.alfaview.com/json/v1/roomService/create Response Notes type should be ROOM_TYPE_ROOM when creating a room or ROOM_TYPE_DEPARTMENT when creating […]

Gast- und Gruppenlinks löschen

Summary Same process for guest and group links Endpoint can only delete one link at a time Required API calls: guestService.v2/deleteLink Request Request POST to https://apis.alfaview.com/json/v1/guestService.v2/deleteLink Response Notes you can get a list of guest […]

API access

API base URL https://apis.alfaview.com/json/v1/ Authentication Servicehttps://apis.alfaview.com/json/v1/authenticationService Business Logic Servicehttps://apis.alfaview.com/json/v1/businessLogicService Company Servicehttps://apis.alfaview.com/json/v1/companyService Guest Servicehttps://apis.alfaview.com/json/v1/guestService.v2 Meeting Servicehttps://apis.alfaview.com/json/v1/meetingService Quota Servicehttps://apis.alfaview.com/json/v1/quotaService Room Servicehttps://apis.alfaview.com/json/v1/roomService User Servicehttps://apis.alfaview.com/json/v1/userService Username/Password credentials can be created via user invite in the admin interface at https://app.alfaview.com/#/accounts/ […]