https://docs.addresszen.com/assets/js/d6e33028.d6227f2f.js

1"use strict";(globalThis.webpackChunk_atlas_docs_zen=globalThis.webpackChunk_atlas_docs_zen||[]).push([[362],{217(e,s,i){i.r(s),i.d(s,{assets:()=>c,contentTitle:()=>t,default:()=>u,frontMatter:()=>r,metadata:()=>a,toc:()=>o});const a=JSON.parse('{"id":"guides/home","title":"Guides","description":"Guides to AddressZen API Keys, billing, testing and integration, grouped by what you are trying to do.","source":"@site/docs/guides/home.mdx","sourceDirName":"guides","slug":"/guides","permalink":"/docs/guides","draft":false,"unlisted":false,"tags":[],"version":"current","frontMatter":{"id":"home","slug":"/guides","title":"Guides","sidebar_label":"Getting Started","description":"Guides to AddressZen API Keys, billing, testing and integration, grouped by what you are trying to do.","hide_title":true},"sidebar":"guides","next":{"title":"API Key","permalink":"/docs/guides/api-key"}}');var d=i(5723),n=i(4056);const r={id:"home",slug:"/guides",title:"Guides",sidebar_label:"Getting Started",description:"Guides to AddressZen API Keys, billing, testing and integration, grouped by what you are trying to do.",hide_title:!0},t="Guides",c={},o=[{value:"Account",id:"account",level:2},{value:"Security",id:"security",level:2},{value:"API",id:"api",level:2},{value:"Migrate",id:"migrate",level:2},{value:"Legal",id:"legal",level:2}];function l(e){const s={code:"code",h1:"h1",h2:"h2",header:"header",p:"p",...(0,n.R)(),...e.components};return(0,d.jsxs)(d.Fragment,{children:[(0,d.jsx)("img",{className:"page-icon",src:"/img/icons/guides.svg",alt:"",width:"64",height:"64"}),"\n",(0,d.jsx)(s.header,{children:(0,d.jsx)(s.h1,{id:"guides",children:"Guides"})}),"\n",(0,d.jsxs)("div",{className:"guides-index",children:[(0,d.jsx)(s.p,{children:"Guides to address verification, integrating our products and managing your account."}),(0,d.jsxs)("div",{className:"guides-start",children:[(0,d.jsxs)("a",{className:"guides-feature",href:"/docs/guides/api-key",children:[(0,d.jsx)("span",{className:"guides-num",children:"01"}),(0,d.jsx)("strong",{children:"API Key"}),(0,d.jsx)("span",{children:"Where to find your key, and what each key controls"})]}),(0,d.jsxs)("a",{className:"guides-feature",href:"/docs/guides/testing",children:[(0,d.jsx)("span",{className:"guides-num",children:"02"}),(0,d.jsx)("strong",{children:"Testing"}),(0,d.jsxs)("span",{children:["Separate test and production keys, and ",(0,d.jsx)(s.code,{children:"ak_test"})," for quick checks"]})]}),(0,d.jsxs)("a",{className:"guides-feature",href:"/docs/guides/llms",children:[(0,d.jsx)("span",{className:"guides-num",children:"03"}),(0,d.jsx)("strong",{children:"AI Assist"}),(0,d.jsx)("span",{children:"llms.txt, the CLI and setup for coding agents and app builders"})]})]}),(0,d.jsx)(s.h2,{id:"account",children:"Account"}),(0,d.jsxs)("div",{className:"guides-list",children:[(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/automated-topups",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Automated Top-Ups"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Top up your API Key balance automatically when it runs low"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/purchasing-lookups",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Purchasing Lookups"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Buy a one-off batch of lookups, and how batches expire"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/sublicensing",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Sublicensing"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"License several organizations under one Key, billed to your account"})]})]}),(0,d.jsx)(s.h2,{id:"security",children:"Security"}),(0,d.jsxs)("div",{className:"guides-list",children:[(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/api-key-secure",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"API Key Security"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Choose the right controls for a frontend or backend integration"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/api-key-settings",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"API Key Settings"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Daily and individual lookup limits, IP address forwarding and log retention"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/allowed-urls",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Allowed URLs"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Restrict a browser key to your own domains"})]})]}),(0,d.jsx)(s.h2,{id:"api",children:"API"}),(0,d.jsxs)("div",{className:"guides-list",children:[(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/error-codes",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Error Codes"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Every API error code by HTTP status, with what raises it and how to fix it."})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/tag-and-track",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Tagging and Usage Tracking"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Label requests with metadata, then query or download your lookup history"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/cli",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"CLI"}),(0,d.jsxs)("span",{className:"guides-row__desc",children:["Search, verify and manage keys from the terminal with ",(0,d.jsx)(s.code,{children:"azn"})]})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/libraries/open-api",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"OpenAPI Specification"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"The machine-readable description of every endpoint, for codegen and tooling"})]}),(0,d.jsxs)("a",{className:"guides-row",href:"/docs/changelog",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Changelog"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"What changed in the API, widgets and dashboard, by date"})]})]}),(0,d.jsx)(s.h2,{id:"migrate",children:"Migrate"}),(0,d.jsx)("div",{className:"guides-list",children:(0,d.jsxs)("a",{className:"guides-row",href:"/docs/how-to-switch",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Switch from Google"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"Replace Place Autocomplete and Address Validation with one script, in three steps"})]})}),(0,d.jsx)(s.h2,{id:"legal",children:"Legal"}),(0,d.jsx)("div",{className:"guides-list",children:(0,d.jsxs)("a",{className:"guides-row",href:"/docs/guides/data",children:[(0,d.jsx)("span",{className:"guides-row__title",children:"Data Processing"}),(0,d.jsx)("span",{className:"guides-row__desc",children:"How GDPR applies to us as your data processor"})]})}),(0,d.jsxs)("p",{className:"guides-help",children:["Need help? ",(0,d.jsx)("a",{href:"https://addresszen.com/support",children:"Contact our support team"})," if you have a question these guides do not answer."]}

1)]})]})}function u(e={}){const{wrapper:s}={...(0,n.R)(),...e.components};return s?(0,d.jsx)(s,{...e,children:(0,d.jsx)(l,{...e})}):l(e)}},4056(e,s,i){i.d(s,{R:()=>r,x:()=>t});var a=i(2155);const d={},n=a.createContext(d);function r(e){const s=a.useContext(n);return a.useMemo(function(){return"function"==typeof e?e(s):{...s,...e}},[s,e])}function t(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(d):e.components||d:r(e.components),a.createElement(n.Provider,{value:s},e.children)}}}]);