{"id":2599,"date":"2024-04-16T12:43:39","date_gmt":"2024-04-16T09:43:39","guid":{"rendered":"https:\/\/akaunting.com\/hc\/docs\/on-premise\/getting-the-api-key\/"},"modified":"2024-04-16T12:51:59","modified_gmt":"2024-04-16T09:51:59","slug":"getting-the-api-key","status":"publish","type":"docs","link":"https:\/\/akaunting.com\/hc\/docs\/on-premise\/getting-the-api-key\/","title":{"rendered":"Getting the API Key"},"content":{"rendered":"\n<p class=\"wp-block-paragraph\">The API Key holds details of your Akaunting plan.<\/p>\n\n\n\n<p class=\"wp-block-paragraph\">To get your API key, you need to sign up for Akaunting via the website.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Go to <a href=\"http:\/\/Akaunting.com\" target=\"_blank\" rel=\"noreferrer noopener\">Akaunting.com<\/a><\/li>\n\n\n\n<li>Click on <a href=\"https:\/\/akaunting.com\/start?utm_source=helpcenter&amp;utm_medium=content&amp;utm_campaign=setting_up_akaunting_cloud\" target=\"_blank\" rel=\"noreferrer noopener\">Get Started<\/a> in the top right corner of the website.<\/li>\n\n\n\n<li>Select <strong>Start<\/strong> on the next screen.<\/li>\n\n\n\n<li>Enter the required fields &#8211; Name, Email, and Password.<\/li>\n\n\n\n<li>Check the terms and conditions box.<\/li>\n\n\n\n<li>Click <strong>Create New Account<\/strong><\/li>\n<\/ul>\n\n\n\n<p class=\"wp-block-paragraph\">You can check your email for a confirmation message and click on the Confirm email address to complete your registration and login.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Go to <a href=\"http:\/\/Akaunting.com\/login\" target=\"_blank\" rel=\"noreferrer noopener\">Akaunting.com\/login<\/a><\/li>\n\n\n\n<li>Enter your account details to access the Account Dashboard.<\/li>\n\n\n\n<li>On Your Account Dashboard, the API Key is at the top of the page.<\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"491\" src=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-1024x491.png\" alt=\"API key on Account Dashboard\" class=\"wp-image-2602\" style=\"width:732px;height:auto\" srcset=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-1024x491.png 1024w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-300x144.png 300w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-768x368.png 768w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-1536x736.png 1536w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124552\/Screenshot-2024-04-15-at-12.58.36-2048x982.png 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<h2 class=\"wp-block-heading\">Entering Your API key<\/h2>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Click the API key to copy it<\/li>\n\n\n\n<li>Paste in the API key field when setting up your company<\/li>\n<\/ul>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"746\" src=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56-1024x746.png\" alt=\"Company set up wiz\" class=\"wp-image-2603\" style=\"width:746px;height:auto\" srcset=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56-1024x746.png 1024w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56-300x219.png 300w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56-768x560.png 768w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56-1536x1119.png 1536w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124640\/Screenshot-2024-04-16-at-10.03.56.png 1850w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n\n\n\n<p class=\"wp-block-paragraph\">You also need the API key to access Apps on Akaunting.<\/p>\n\n\n\n<figure class=\"wp-block-image size-large is-resized\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"396\" src=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54-1024x396.png\" alt=\"Enter API Key to access apps on Akaunting\" class=\"wp-image-2604\" style=\"width:755px;height:auto\" srcset=\"https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54-1024x396.png 1024w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54-300x116.png 300w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54-768x297.png 768w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54-1536x594.png 1536w, https:\/\/assets.akaunting.com\/hc\/2024\/04\/16124745\/Screenshot-2024-04-16-at-10.26.54.png 1976w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>The API Key holds details of your Akaunting plan. To get your API key, you need to sign up for Akaunting via the website. You can check your email for a confirmation message and click on the Confirm email address to complete your registration and login. Entering Your API key You also need the API [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":0,"parent":8,"menu_order":4,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"class_list":["post-2599","docs","type-docs","status-publish","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/2599","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/comments?post=2599"}],"version-history":[{"count":2,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/2599\/revisions"}],"predecessor-version":[{"id":2605,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/2599\/revisions\/2605"}],"up":[{"embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/docs\/8"}],"wp:attachment":[{"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/media?parent=2599"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/akaunting.com\/hc\/wp-json\/wp\/v2\/doc_tag?post=2599"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}