API Key Types

GoldLeaf has the following API key types:

  • Admin
  • Customer

API keys do not provide front-end UI authentication.

Admin API Keys

Admin API keys have the same permissions as an admin user. They should be treated securely and not shared with others.

⚠️ Warning: Admin API keys have the same permissions within your organization as an admin user and should be stored securely. Ensure that your API keys are kept confidential and not exposed in client-side code or public repositories.

Customer API Keys

Customer API keys have restricted permissions and allow limited access to your data. For example, this includes creating hose assemblies, fetching customer-specific data like pricing, creating data sheets, and similar.

A customer API key has no access to your organization’s costs, only its pricing. Further, if no customerId (or an invalid one) is passed with a request GoldLeaf will use your organization’s defaults for pricing.

Last Updated::