https://docs.addresszen.com/assets/js/a878831b.5c79575f.js

1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[983],{3437(e,s,t){t.r(s),t.d(s,{assets:()=>d,contentTitle:()=>o,default:()=>h,frontMatter:()=>r,metadata:()=>i,toc:()=>c});const i=JSON.parse('{"id":"guides/api-key","title":"API Key","description":"Your API Keys are listed on your dashboard after you sign in. An API Key generally begins with the characters ak_.","source":"@site/docs/guides/api-key.mdx","sourceDirName":"guides","slug":"/guides/api-key","permalink":"/docs/guides/api-key","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"title":"API Key","sidebar_label":"API Key"},"sidebar":"guides","previous":{"title":"Getting Started","permalink":"/docs/guides"},"next":{"title":"API Key Settings","permalink":"/docs/guides/api-key-settings"}}');var n=t(5723),a=t(4056);const r={title:"API Key",sidebar_label:"API Key"},o=void 0,d={},c=[{value:"Where do I find it and what does it look like?",id:"where-do-i-find-it-and-what-does-it-look-like",level:2},{value:"What is an API Key?",id:"what-is-an-api-key",level:2},{value:"How many API Keys can I have?",id:"how-many-api-keys-can-i-have",level:2},{value:"What each API Key controls",id:"what-each-api-key-controls",level:2},{value:"Next steps",id:"next-steps",level:2}];function l(e){const s={a:"a",code:"code",h2:"h2",li:"li",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,a.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsxs)(s.p,{children:["Your API Keys are listed on your ",(0,n.jsx)(s.a,{href:"https://ideal-postcodes.co.uk/tokens",children:"dashboard"})," after you sign in. An API Key generally begins with the characters ",(0,n.jsx)(s.code,{children:"ak_"}),"."]}),"\n",(0,n.jsx)(s.h2,{id:"where-do-i-find-it-and-what-does-it-look-like",children:"Where do I find it and what does it look like?"}),"\n",(0,n.jsx)(s.p,{children:"Sign in to your account and open your dashboard. Each API Key is listed there, and looks like this:"}),"\n",(0,n.jsx)(s.pre,{children:(0,n.jsx)(s.code,{className:"language-text",metastring:'title="terminal"',children:"ak_ksqa49sjSdAEDq9I88\n"})}),"\n",(0,n.jsx)(s.h2,{id:"what-is-an-api-key",children:"What is an API Key?"}),"\n",(0,n.jsx)(s.p,{children:"An API Key is a string of characters that authenticates your integration with us. It tells us who is accessing our services."}),"\n",(0,n.jsx)(s.p,{children:"When your integration searches our database for an address, it sends us your API Key to tell us who you are. Include your API Key in every integration."}),"\n",(0,n.jsx)(s.h2,{id:"how-many-api-keys-can-i-have",children:"How many API Keys can I have?"}),"\n",(0,n.jsx)(s.p,{children:"You can create up to 10 API Keys. Create more keys on your account via the dashboard."}),"\n",(0,n.jsx)(s.p,{children:"Your first API Key receives a test balance of 100 lookups."}),"\n",(0,n.jsx)(s.h2,{id:"what-each-api-key-controls",children:"What each API Key controls"}),"\n",(0,n.jsx)(s.p,{children:"Each API Key has its own balance, security and notification settings."}),"\n",(0,n.jsxs)(s.table,{children:[(0,n.jsx)(s.thead,{children:(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.th,{children:"Setting"}),(0,n.jsx)(s.th,{children:"What it does"}),(0,n.jsx)(s.th,{children:"Guide"})]})}),(0,n.jsxs)(s.tbody,{children:[(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Authentication"}),(0,n.jsx)(s.td,{children:"Identifies your integration. Send the key with every address search and validation request."}),(0,n.jsx)(s.td,{children:"-"})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Security"}),(0,n.jsx)(s.td,{children:"Restricts where and how much the key can be used. You configure these settings yourself."}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"/docs/guides/api-key-secure",children:"API Key Security"})})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Notifications"}),(0,n.jsx)(s.td,{children:"Sends balance notifications, top-up updates and other actionable information to the key's email notification list."}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"/docs/guides/automated-topups",children:"Automated Top-Ups"})})]}),(0,n.jsxs)(s.tr,{children:[(0,n.jsx)(s.td,{children:"Balance"}),(0,n.jsx)(s.td,{children:"Holds the key's own lookup balance. You generally buy a lookup balance ahead of time to access address data."}),(0,n.jsx)(s.td,{children:(0,n.jsx)(s.a,{href:"/docs/guides/purchasing-lookups",children:"Purchasing Lookups"})})]})]})]}),"\n",(0,n.jsxs)(s.p,{children:["See our guide on ",(0,n.jsx)(s.a,{href:"https://ideal-postcodes.co.uk/guides/what-is-a-lookup",children:"what is a lookup"})," to find out which searches use your balance."]}),"\n",(0,n.jsx)(s.h2,{id:"next-steps",children:"Next steps"}),"\n",(0,n.jsxs)(s.ul,{children:["\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.a,{href:"/docs/guides/api-key-settings",children:"API Key Settings"}),": set daily and individual lookup limits"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.a,{href:"/docs/guides/api-key-secure",children:"API Key Security"}),": choose the right controls for a browser or server integration"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.a,{href:"/docs/guides/allowed-urls",children:"Allowed URLs"}),": restrict a browser key to your website"]}),"\n",(0,n.jsxs)(s.li,{children:[(0,n.jsx)(s.a,{href:"/docs/guides/automated-topups",children:"Automated Top-Ups"}),": keep your balance topped up"]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,a.R)(),...e.components};return s?(0,n.jsx)(s,{...e,children:(0,n.jsx)(l,{...e})}):l(e)}},4056(e,s,t){t.d(s,{R:()=>r,x:()=>o});var i=t(2155);const n={},a=i.createContext(n);function r(e){const s=i.useContext(a);return i.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function o(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:r(e.components),i.createElement(a.Provider,{value:s},e.children)}}}]);