{"id":6358,"date":"2025-07-03T12:09:24","date_gmt":"2025-07-03T12:09:24","guid":{"rendered":"https:\/\/support.alfaview.com\/?page_id=6358"},"modified":"2025-07-03T12:10:04","modified_gmt":"2025-07-03T12:10:04","slug":"api-access","status":"publish","type":"page","link":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/developers\/request-your-api-credentials\/usage-examples\/api-access\/","title":{"rendered":"API access"},"content":{"rendered":"\n<ul class=\"wp-block-list\">\n<li>API base URL <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/<\/code><\/mark><\/li>\n\n\n\n<li>Common API endpoints\n<ul class=\"wp-block-list\">\n<li>Authentication Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/authenticationService<\/code><\/mark><\/li>\n\n\n\n<li>Business Logic Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/businessLogicService<\/code><\/mark><\/li>\n\n\n\n<li>Company Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/companyService<\/code><\/mark><\/li>\n\n\n\n<li>Guest Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/guestService.v2<\/code><\/mark><\/li>\n\n\n\n<li>Meeting Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/meetingService<\/code><\/mark><\/li>\n\n\n\n<li>Quota Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/quotaService<\/code><\/mark><\/li>\n\n\n\n<li>Room Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/roomService<\/code><\/mark><\/li>\n\n\n\n<li>User Service<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/apis.alfaview.com\/json\/v1\/userService<\/code><\/mark><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>Username\/Password credentials can be created via user invite in the admin interface at https:\/\/app.alfaview.com\/#\/accounts\/<\/li>\n\n\n\n<li>API keys need to be created via account management in the admin interface at https:\/\/app.alfaview.com\/#\/settings\/<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"constants\">Constants<a href=\"#constants\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Define a <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>requestId<\/code><\/mark> function that generates unique identifiers for debugging requests later on<\/li>\n\n\n\n<li>DEPRECATED: Define a constant for guest access codes (random string)<\/li>\n\n\n\n<li>DEPRECATED: Define a constant for join link base url <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>https:\/\/app.alfaview.com\/#\/join\/<\/code><\/mark><\/li>\n\n\n\n<li>DEPRECATED: Define a constant for roles (Should now be retrieved from the <em>Business Logic Service<\/em>)\n<ul class=\"wp-block-list\">\n<li>Moderator:<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>{ \"voice\": true, \"video\": true, \"promote\": true, \"join\": true, \"screen\": true, \"chat\": true, \"chatBroadcast\": true }<\/code><\/mark><\/li>\n\n\n\n<li>Participant:<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>{ \"voice\": true, \"video\": true, \"join\": true, \"screen\": true, \"chat\": true }<\/code><\/mark><\/li>\n\n\n\n<li>Spectator:<br><mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>{ \"join\": true, \"chat\": true }<\/code><\/mark><\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"error-handling\">Error handling<a href=\"#error-handling\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<p><strong>Examples<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"replyInfo\": {\n    \"requestId\": \"z3ai9B11509\",\n    \"statusMessage\": \"OK\"\n  },\n  ...\n}\n<\/code><\/pre>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n  \"code\": 16,\n  \"message\": \"token expired\",\n  \"details\": &#91;\n    {\n      \"@type\": \"type.googleapis.com\/common.ReplyInfo\",\n      \"requestId\": \"tn5BoQ10239\",\n      \"statusCode\": \"TOKEN_OUTDATED\",\n      \"statusMessage\": \"token expired\"\n    }\n  ]\n}\n<\/code><\/pre>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"notes\">Notes<a href=\"#notes\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>API Responses contain a <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>replyInfo<\/code><\/mark><\/li>\n\n\n\n<li>Check containing <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>statusMessage<\/code><\/mark> to be <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>OK<\/code><\/mark><\/li>\n\n\n\n<li>If error says <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>token expired<\/code><\/mark> you will have to reauthenticate<\/li>\n\n\n\n<li>I error says <mark style=\"background-color:rgba(0, 0, 0, 0)\" class=\"has-inline-color has-vivid-cyan-blue-color\"><code>context deadline exceeded<\/code><\/mark> there was a timeout and the request needs to be reissued<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>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\/ [&hellip;]<\/p>\n","protected":false},"author":9,"featured_media":0,"parent":3170,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-6358","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6358","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/comments?post=6358"}],"version-history":[{"count":1,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6358\/revisions"}],"predecessor-version":[{"id":6359,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/6358\/revisions\/6359"}],"up":[{"embeddable":true,"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/pages\/3170"}],"wp:attachment":[{"href":"https:\/\/cp-prod-wordpress.alfa.sx\/de\/wp-json\/wp\/v2\/media?parent=6358"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}