Skip to Content
Odoo Menu
  • Sign in
  • Try it free
  • Apps
    Finance
    • Accounting
    • Invoicing
    • Expenses
    • Spreadsheet (BI)
    • Documents
    • Sign
    Sales
    • CRM
    • Sales
    • POS Shop
    • POS Restaurant
    • Subscriptions
    • Rental
    Websites
    • Website Builder
    • eCommerce
    • Blog
    • Forum
    • Live Chat
    • eLearning
    Supply Chain
    • Inventory
    • Manufacturing
    • PLM
    • Purchase
    • Maintenance
    • Quality
    Human Resources
    • Employees
    • Recruitment
    • Time Off
    • Appraisals
    • Referrals
    • Fleet
    Marketing
    • Social Marketing
    • Email Marketing
    • SMS Marketing
    • Events
    • Marketing Automation
    • Surveys
    Services
    • Project
    • Timesheets
    • Field Service
    • Helpdesk
    • Planning
    • Appointments
    Productivity
    • Discuss
    • Approvals
    • IoT
    • VoIP
    • Knowledge
    • WhatsApp
    Third party apps Odoo Studio Odoo Cloud Platform
  • Industries
    Retail
    • Book Store
    • Clothing Store
    • Furniture Store
    • Grocery Store
    • Hardware Store
    • Toy Store
    Food & Hospitality
    • Bar and Pub
    • Restaurant
    • Fast Food
    • Guest House
    • Beverage Distributor
    • Hotel
    Real Estate
    • Real Estate Agency
    • Architecture Firm
    • Construction
    • Estate Management
    • Gardening
    • Property Owner Association
    Consulting
    • Accounting Firm
    • Odoo Partner
    • Marketing Agency
    • Law firm
    • Talent Acquisition
    • Audit & Certification
    Manufacturing
    • Textile
    • Metal
    • Furnitures
    • Food
    • Brewery
    • Corporate Gifts
    Health & Fitness
    • Sports Club
    • Eyewear Store
    • Fitness Center
    • Wellness Practitioners
    • Pharmacy
    • Hair Salon
    Trades
    • Handyman
    • IT Hardware & Support
    • Solar Energy Systems
    • Shoe Maker
    • Cleaning Services
    • HVAC Services
    Others
    • Nonprofit Organization
    • Environmental Agency
    • Billboard Rental
    • Photography
    • Bike Leasing
    • Software Reseller
    Browse all Industries
  • Community
    Learn
    • Tutorials
    • Documentation
    • Certifications
    • Training
    • Blog
    • Podcast
    Empower Education
    • Education Program
    • Scale Up! Business Game
    • Visit Odoo
    Get the Software
    • Download
    • Compare Editions
    • Releases
    Collaborate
    • Github
    • Forum
    • Events
    • Translations
    • Become a Partner
    • Services for Partners
    • Register your Accounting Firm
    Get Services
    • Find a Partner
    • Find an Accountant
    • Meet an advisor
    • Implementation Services
    • Customer References
    • Support
    • Upgrades
    Github Youtube Twitter Linkedin Instagram Facebook Spotify
    +1 (650) 691-3277
    Get a demo
  • Pricing
  • Help

Odoo is the world's easiest all-in-one management software.
It includes hundreds of business apps:

  • CRM
  • e-Commerce
  • Accounting
  • Inventory
  • PoS
  • Project
  • MRP
All apps
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
You need to be registered to interact with the community.
All Posts People Badges
Tags (View all)
odoo accounting v14 pos v15
About this forum
Help

API Keys and access in Odoo.sh

Subscribe

Get notified when there's activity on this post

This question has been flagged
Odoo.shapi-key
1 Reply
1188 Views
Avatar
Rutger Hofste

Dear Community,

We’re currently implementing Odoo on Odoo.sh for a client, with the goal of enhancing certain data flows using AI agents. For this we need API keys, and I’d like to clarify the best practices around managing them across environments.

I’m already familiar with the stages, branches, and build logic of Odoo.sh. In production and staging, I created a dedicated user and generated an API key, which works fine.

My main question is about the testing environment. Since Odoo.sh rebuilds the environment from scratch, what is the recommended approach to ensure stable API access?

  • Should I use the testing branch to test API connections, or is there a better workflow?
  • If API access is possible in testing, which user account should be used: the default admin or a separate dedicated account?

Any advice or best practices from your experience would be greatly appreciated.

Thank you in advance!

0
Avatar
Discard
Avatar
Cybrosys Techno Solutions Pvt.Ltd
Best Answer

Hi,


When using Odoo.sh, API keys are tied to user accounts, not the instance itself. This means that whenever a testing environment is rebuilt, any manually created keys will be lost unless you migrate them. For that reason, it’s important to plan how API users and keys are managed across production, staging, and testing.


The best practice is to create a dedicated technical user for API access instead of using the default admin account. This makes it easier to control permissions, audit usage, and revoke or rotate keys when needed. Ideally, you should maintain separate API users for production and for testing/staging, so production data is never exposed during development.


In Odoo.sh testing environments, it’s not reliable to create keys manually since they won’t persist after rebuilds. Instead, keys should either be injected through environment variables or automatically provisioned using a bootstrap script or module that creates the API user and key during deployment. This ensures your developers always have consistent test credentials without manual setup.


Finally, the staging branch is the most suitable place for realistic API testing, because it contains a persistent copy of the production database. The testing branch, being short-lived, should only be used with injected or automatically created test credentials. This approach keeps production keys safe while still enabling stable API access for testing and development.



Hope it helps

0
Avatar
Discard
Enjoying the discussion? Don't just read, join in!

Create an account today to enjoy exclusive features and engage with our awesome community!

Sign up
Related Posts Replies Views Activity
How to Add a User to Access the Database on Odoo.sh?
Odoo.sh
Avatar
Avatar
1
Oct 25
3979
Odoo.SH Github account ownership transfer, trying to change the repository
Odoo.sh
Avatar
Avatar
Avatar
2
Mar 25
8000
Odoo.sh sale commission Solved
Odoo.sh
Avatar
Avatar
1
Aug 23
2827
Odoo.sh Bad Gateway
Odoo.sh
Avatar
0
Nov 21
3837
Unable to drag builds between branches in Odoo.sh (works on other computers) Solved
odoo.sh Odoo.sh
Avatar
Avatar
1
Oct 25
915
Community
  • Tutorials
  • Documentation
  • Forum
Open Source
  • Download
  • Github
  • Runbot
  • Translations
Services
  • Odoo.sh Hosting
  • Support
  • Upgrade
  • Custom Developments
  • Education
  • Find an Accountant
  • Find a Partner
  • Become a Partner
About us
  • Our company
  • Brand Assets
  • Contact us
  • Jobs
  • Events
  • Podcast
  • Blog
  • Customers
  • Legal • Privacy
  • Security
الْعَرَبيّة Català 简体中文 繁體中文 (台灣) Čeština Dansk Nederlands English Suomi Français Deutsch हिंदी Bahasa Indonesia Italiano 日本語 한국어 (KR) Lietuvių kalba Język polski Português (BR) română русский язык Slovenský jazyk slovenščina Español (América Latina) Español ภาษาไทย Türkçe українська Tiếng Việt

Odoo is a suite of open source business apps that cover all your company needs: CRM, eCommerce, accounting, inventory, point of sale, project management, etc.

Odoo's unique value proposition is to be at the same time very easy to use and fully integrated.

Website made with

Odoo Experience on YouTube

1. Use the live chat to ask your questions.
2. The operator answers within a few minutes.

Live support on Youtube
Watch now