Learn about best practices for using the Drivly SDK and APIs.
Use the Sandbox
The sandbox environment is a great way to test your integration with the Drivly API. It allows you to test your integration without affecting your production data.Our upstream providers require that testing be done strictly inside the sandbox, as to not affect any real-world data.
The production API affects real-world data, so testing in production can lead to a suspension of your
account.
Avoid Caching
Our APIs are designed to be fast and reliable. That said, caching the results of API calls may lead to stale data being reported to your customers, users, and staff.We recommend that you avoid caching the results of API calls, or if you must cache, use a short cache time.
Use the Latest SDK Version
We are constantly improving the Drivly SDK. To take advantage of the latest features and improvements, always use the latest version of the SDK.
API Key Best Practices
Keep your API keys private: Treat them as sensitive data and avoid exposing them in public repositories, client-side code, or anywhere they could be accessed by unauthorized individuals.
Use environment variables: Store API keys in environment variables or secure app settings to keep them secure.
Rotate keys regularly: Periodically change API keys to minimize the risk of old keys being misused.
Apply least privilege: Grant the minimum permissions necessary for the key to function, reducing the potential impact of a compromised key.
By following these guidelines and using API keys effectively, you can enhance the security and efficiency of your application’s interaction with our APIs.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Drivly Docs","colors":{"primary":"#00CAB9","light":"#A8F6F6","dark":"#03C2B2"},"favicon":"favicon.svg","logo":{"light":"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/light.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=2949247e5550eeee3c33c8516df55d81","dark":"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/dark.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=f76b40c1a0f68056c33562b70022bce6"},"background":{"decoration":null,"color":{"light":null,"dark":"#121212"}},"navbar":{"links":[{"label":"Contact","href":"mailto:sales@driv.ly"}],"primary":{"type":"button","label":"Join waitlist","href":"https://drivly.ai/contact"}},"footer":{"socials":{"twitter":"https://twitter.com/drivly","github":"https://github.com/drivly","linkedin":"https://www.linkedin.com/company/drivly"}},"integrations":{"ga4":{"measurementId":"G-T45DEGR8GE"}},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"drivly","hasAudioNarration":false,"actualSubdomain":"drivly","customDomains":["docs.driv.ly"],"gitSource":{"type":"github","owner":"drivly","repo":"docs.driv.ly","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91466db2c906e68551948:success","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Documentation","count":290},{"language":"default","tag":"API Reference","count":188},{"language":"default","tag":"Services","count":166},{"language":"default","tag":"Data","count":92},{"language":"default","tag":"Commerce","count":52},{"language":"default","tag":"AI","count":43},{"language":"default","tag":"Entities","count":32},{"language":"default","tag":"Companies","count":26},{"language":"default","tag":"Vehicle","count":21},{"language":"default","tag":"Listings","count":20}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[],"googleFontsInlined":false},"customCss":[{"filePath":"snippets/snippets.css","content":":root{--story-board-background: #f9f8fc;--story-board-border: #e2e2e7;--hero-background: #fbfbfc}.dark{--story-board-background: #1a1a1a;--story-board-border: #333;--hero-background: #1a1a1a}.storyBoard{padding:32px 24px;background-color:var(--story-board-background);font-size:16px;line-height:36px;border-radius:4px}.heroContent{background-color:var(--hero-background)}"}],"page":{"pagePath":"developers/best-practices","slug":"/developers/best-practices","pageMetadata":{"title":"Best Practices","description":"Learn about best practices for using the Drivly SDK and APIs.","href":"/developers/best-practices"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Learn about best practices for using the Drivly SDK and APIs.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={hr:`hr`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Warning}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`use-the-sandbox`,children:`Use the Sandbox`}),`\n`,_jsx(_components.p,{children:`The sandbox environment is a great way to test your integration with the Drivly API. It allows you to test your integration without affecting your production data.`}),`\n`,_jsx(_components.p,{children:`Our upstream providers require that testing be done strictly inside the sandbox, as to not affect any real-world data.`}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`The production API affects real-world data, so testing in production can lead to a suspension of your\naccount.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`avoid-caching`,children:`Avoid Caching`}),`\n`,_jsx(_components.p,{children:`Our APIs are designed to be fast and reliable. That said, caching the results of API calls may lead to stale data being reported to your customers, users, and staff.`}),`\n`,_jsx(_components.p,{children:`We recommend that you avoid caching the results of API calls, or if you must cache, use a short cache time.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`use-the-latest-sdk-version`,children:`Use the Latest SDK Version`}),`\n`,_jsx(_components.p,{children:`We are constantly improving the Drivly SDK. To take advantage of the latest features and improvements, always use the latest version of the SDK.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`api-key-best-practices`,children:`API Key Best Practices`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Keep your API keys private:`}),` Treat them as sensitive data and avoid exposing them in public repositories, client-side code, or anywhere they could be accessed by unauthorized individuals.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Use environment variables:`}),` Store API keys in environment variables or secure app settings to keep them secure.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Rotate keys regularly:`}),` Periodically change API keys to minimize the risk of old keys being misused.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Apply least privilege:`}),` Grant the minimum permissions necessary for the key to function, reducing the potential impact of a compromised key.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`By following these guidelines and using API keys effectively, you can enhance the security and efficiency of your application’s interaction with our APIs.`})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Best Practices","description":"Learn about best practices for using the Drivly SDK and APIs.","href":"/developers/best-practices"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Use the Sandbox","slug":"use-the-sandbox","depth":2,"children":[]},{"title":"Avoid Caching","slug":"avoid-caching","depth":2,"children":[]},{"title":"Use the Latest SDK Version","slug":"use-the-latest-sdk-version","depth":2,"children":[]},{"title":"API Key Best Practices","slug":"api-key-best-practices","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/drivly/e3b0c44298fc1c14/augment-docs.js","/_mintlify/custom/drivly/13b28860dab2dbb1/generate-examples.js","/_mintlify/custom/drivly/51178f86c52b51b0/commerce/needWork.js","/_mintlify/custom/drivly/2c75ac436d1b00e4/services/finance-and-insurance/pre-approval/otherApi.js","/_mintlify/custom/drivly/c218e26da81e9d98/commerce/ohNotWorking.js","/_mintlify/custom/drivly/20977b91dae647eb/ai/validate.js"],"subdomain":"drivly","siteName":"Drivly Docs","title":"Best Practices - Drivly Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-06T22:49:28.254Z","originalFileLocation":"developers/best-practices.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Learn about best practices for using the Drivly SDK and APIs.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Drivly Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Best Practices - Drivly Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Learn about best practices for using the Drivly SDK and APIs.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Drivly Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.driv.ly/developers/best-practices\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://drivly.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=Best+Practices\u0026amp;description=Learn+about+best+practices+for+using+the+Drivly+SDK+and+APIs.\u0026amp;theme=96587be3e6002a2d3f25d11a\u0026amp;signature=c0cc824a9262f769f9f7ce528cdf08022a8450fddcfa374fd355cbc3bcce5b70\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Best Practices - Drivly Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Learn about best practices for using the Drivly SDK and APIs.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://drivly.mintlify.site/_mintlify/api/og/v2?division=Developers\u0026amp;title=Best+Practices\u0026amp;description=Learn+about+best+practices+for+using+the+Drivly+SDK+and+APIs.\u0026amp;theme=96587be3e6002a2d3f25d11a\u0026amp;signature=c0cc824a9262f769f9f7ce528cdf08022a8450fddcfa374fd355cbc3bcce5b70\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/drivly/OmbkdjlTxkakLvzd/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Drivly Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00CAB9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.driv.ly/developers/best-practices\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/developers/best-practices.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.driv.ly/#organization\",\"name\":\"Drivly Docs\",\"url\":\"https://docs.driv.ly\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/drivly/lS-LOhC8keZU5zBZ/logo/light.svg?fit=max\u0026auto=format\u0026n=lS-LOhC8keZU5zBZ\u0026q=85\u0026s=2949247e5550eeee3c33c8516df55d81\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.driv.ly#website\",\"name\":\"Drivly Docs\",\"url\":\"https://docs.driv.ly\",\"publisher\":{\"@id\":\"https://docs.driv.ly/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.driv.ly/developers/best-practices#webpage\",\"url\":\"https://docs.driv.ly/developers/best-practices\",\"name\":\"Best Practices\",\"description\":\"Learn about best practices for using the Drivly SDK and APIs.\",\"dateModified\":\"2026-01-06T22:49:28.254Z\",\"isPartOf\":{\"@id\":\"https://docs.driv.ly#website\"},\"breadcrumb\":{\"@id\":\"https://docs.driv.ly/developers/best-practices#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.driv.ly/developers/best-practices#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Drivly Docs\",\"item\":\"https://docs.driv.ly\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Best Practices\",\"item\":\"https://docs.driv.ly/developers/best-practices\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.driv.ly/developers/best-practices#article\",\"headline\":\"Best Practices\",\"name\":\"Best Practices\",\"description\":\"Learn about best practices for using the Drivly SDK and APIs.\",\"url\":\"https://docs.driv.ly/developers/best-practices\",\"mainEntityOfPage\":{\"@id\":\"https://docs.driv.ly/developers/best-practices#webpage\"},\"dateModified\":\"2026-01-06T22:49:28.254Z\",\"publisher\":{\"@id\":\"https://docs.driv.ly/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.driv.ly#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Drivly Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Drivly Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/developers/best-practices.md","siteName":"Drivly Docs","nav":{"global":null,"anchors":[{"anchor":"Documentation","icon":"book-open","tabs":[{"tab":"Get Started","groups":[{"group":"Get Started","pages":[{"title":"Introduction","description":"The Drivly Platform","href":"/get-started/introduction"}]},{"group":"Developers","pages":[{"title":"Best Practices","href":"/developers/best-practices"},{"title":"Drivly UI","sidebarTitle":"Drivly UI","mode":"wide","description":"Everything you need to build modern automotive experiences.","href":"/developers/drivly-ui"}]},{"group":"Education","pages":[{"title":"What is a VIN?","href":"/education/what-is-a-vin"},{"title":"What is a Squish VIN?","href":"/education/what-is-a-squish-vin"}]}]},{"tab":"Data","pages":[{"title":"Data","href":"/data/overview"}]},{"tab":"Services","pages":[{"title":"Services","href":"/services/overview"}]},{"tab":"Commerce","pages":[{"title":"Commerce","href":"/commerce/overview"}]},{"tab":"AI","pages":[{"title":"AI","href":"/ai/overview"}]}]},{"anchor":"Auth","icon":"user-shield","pages":[{"title":"Auth","href":"/developers/auth/overview"}]},{"anchor":"SDK","icon":"layer-group","pages":[{"title":"SDK","href":"/developers/sdk/overview"}]},{"anchor":"Webhooks","icon":"webhook","pages":[{"title":"Webhooks","href":"/developers/webhooks/overview"}]}]},"basePath":"","title":"Best Practices - Drivly Docs","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":[],"chunks":[]}