{"id":10524,"date":"2026-02-23T07:24:49","date_gmt":"2026-02-23T07:24:49","guid":{"rendered":"https:\/\/support.alfaview.com\/?page_id=10524"},"modified":"2026-02-23T07:52:11","modified_gmt":"2026-02-23T07:52:11","slug":"generate-api-credentials","status":"publish","type":"page","link":"https:\/\/support.alfaview.com\/en\/developers\/generate-api-credentials\/","title":{"rendered":"Generate API credentials"},"content":{"rendered":"\n<p>To generate your API credentials, do the following:<\/p>\n\n\n\n<div class=\"wp-block-columns is-layout-flex wp-container-core-columns-is-layout-9d6595d7 wp-block-columns-is-layout-flex\">\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:66.66%\">\n<ul class=\"wp-block-list\">\n<li>Log in to the&nbsp;<a href=\"https:\/\/support.alfaview.com\/en\/administration\/general\/adminstration-interface\/\">administration interface<\/a>.<\/li>\n\n\n\n<li>Click on <strong>Company<\/strong> in the menu on the left.<\/li>\n\n\n\n<li>Click on the <strong>API keys<\/strong> tab.<\/li>\n\n\n\n<li>Enter a name in the Alias field.<\/li>\n\n\n\n<li>Click <button class=\"av-button av-button--primary\">Create<\/button>.<\/li>\n\n\n\n<li>Save or make a note of the alias, code, and account ID.<\/li>\n\n\n\n<li>Use the alias, code, and account ID to authenticate yourself in your API client.<\/li>\n<\/ul>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-layout-flow wp-block-column-is-layout-flow\" style=\"flex-basis:33.33%\"><div class=\"wp-block-image\">\n<figure class=\"alignright size-full\"><a href=\"https:\/\/support.alfaview.com\/wp-content\/uploads\/2026\/02\/alfaview_api-key-generate_en.png\"><img loading=\"lazy\" decoding=\"async\" width=\"780\" height=\"347\" src=\"https:\/\/support.alfaview.com\/wp-content\/uploads\/2026\/02\/alfaview_api-key-generate_en.png\" alt=\"API access data can be generated under the \u201cCompany\u201d menu item in the administration interface.\" class=\"wp-image-10598\" srcset=\"https:\/\/support.alfaview.com\/wp-content\/uploads\/2026\/02\/alfaview_api-key-generate_en.png 780w, https:\/\/support.alfaview.com\/wp-content\/uploads\/2026\/02\/alfaview_api-key-generate_en-300x133.png 300w, https:\/\/support.alfaview.com\/wp-content\/uploads\/2026\/02\/alfaview_api-key-generate_en-768x342.png 768w\" sizes=\"auto, (max-width: 780px) 100vw, 780px\" \/><\/a><figcaption class=\"wp-element-caption\">Generate API credentials<\/figcaption><\/figure>\n<\/div><\/div>\n<\/div>\n\n\n\n<h2 class=\"wp-block-heading\" class=\"wp-block-heading\" id=\"api-documentation\">API Documentation<a href=\"#api-documentation\" class=\"av-heading-anchor\"><i class=\"bi bi-link\"><\/i><\/a><\/h2>\n\n\n\n<p>The <strong>API Documentation<\/strong> contains links to the current API versions and <a href=\"https:\/\/apis.alfaview.com\/v2\/docs\/openapi\">the most common uses of the API<\/a>. It also allows you to download the documentation and use external tools to generate code that you can use directly with our API.<\/p>\n\n\n\n<p><strong>OpenAPI 3.1<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/apis.alfaview.com\/v2\/docs\/openapi.json\">JSON<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/apis.alfaview.com\/v2\/docs\/openapi.yaml\">YAML<\/a><\/li>\n<\/ul>\n\n\n\n<p><strong>OpenAPI 3.0.3<\/strong><\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/apis.alfaview.com\/v2\/docs\/openapi-3.0.json\">JSON<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/apis.alfaview.com\/v2\/docs\/openapi-3.0.yaml\">YAML<\/a><\/li>\n<\/ul>\n\n\n\n<div class=\"wp-block-alfaview-callout\">\n<p>We recommend switching to the more recent <a href=\"https:\/\/apis.alfaview.com\/\"><strong>Version 2<\/strong><\/a> now, as Version 1 no longer offers control over all features and will not receive new functionality. It will be <strong>discontinued in March 2027<\/strong>.<\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>To generate your API credentials, do the following: Log in to the&nbsp;administration interface. Click on Company in the menu on the left. Click on the API keys tab. Enter a name in the Alias field. [&hellip;]<\/p>\n","protected":false},"author":9,"featured_media":0,"parent":561,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-10524","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/pages\/10524","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/users\/9"}],"replies":[{"embeddable":true,"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/comments?post=10524"}],"version-history":[{"count":6,"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/pages\/10524\/revisions"}],"predecessor-version":[{"id":10600,"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/pages\/10524\/revisions\/10600"}],"up":[{"embeddable":true,"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/pages\/561"}],"wp:attachment":[{"href":"https:\/\/support.alfaview.com\/en\/wp-json\/wp\/v2\/media?parent=10524"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}