View Categories

Creating 3rd Party Vendor API Keys

1 min read

Purpose #

This process outlines how to onboard a new third-party DMS/WMS vendor and generate API access credentials.

Step 1: Connect to the Database #

  • Connect to the OS_Automan database
  • Connection details are stored in LastPass

Step 2: Create / Verify Company #

  • Check if the DMS/WMS company already exists in:
sso.companies
  • If not, add a new record
  • This represents the vendor’s company (DMS/WMS level)

✅ Note: Ensure the company name and identifiers match what the vendor will use in production.

Step 3: Create / Verify Branch #

  • Check if the relevant branch exists in:
sso.branches
  • If not, add a new record
  • This represents the specific branch the API will be linked to

⚠️ The branch must be linked to the correct companyID

Step 4: Create Vendor Record #

  • Insert a new record into:
third_party_dms_vendors.vendors
  • This entry represents the external developer / vendor consuming the API

API Key Generation #

🔐 Store the generated API key securely and share it only via approved secure channels.

Step 5: Create Vendor Credentials #

  • Insert a new record into:
third_party_dms_vendors.external_vendor_credentials
  • Populate with:
    • Generated API key
    • companyID
    • branchID
    • Any required status/activation flags

✅ This step links the vendor to the correct company and branch and enables API access.

Final Checks #

  • Confirm:
    • Company ↔ Branch relationship is correct
    • Vendor is active
    • API key is correctly stored and mapped
  • Notify the vendor that credentials are ready for testing