Overview
Komerza’s OAuth2 system enables third-party developers to create applications that can securely access user accounts with explicit user consent. This allows you to build integrations, plugins, and services that interact with Komerza stores on behalf of users.Create Your Application
Register your OAuth2 application in the Komerza Dashboard
How It Works
1
Create an Application
Register your application with Komerza, specifying the permissions you need
and your redirect URLs.
2
User Authorization
Redirect users to Komerza’s authorization page where they can review and
approve your app’s access.
3
Receive Authorization Code
After approval, users are redirected back to your app with a temporary
authorization code.
4
Exchange for API Key
Exchange the authorization code for a JWT API key that grants access to the
authorized stores.
Authorization URL
Send users to the following URL to initiate the OAuth2 flow:Query Parameters
Example Authorization URL
OAuth2 Flow Diagram
Permissions & Scopes
When creating your application, you must specify which permissions (scopes) your app requires. Users will see these permissions during the authorization flow and can choose which stores to grant access to.View All API Scopes
Complete reference for all available permission scopes
Security Best Practices
Use HTTPS
All redirect URLs should use HTTPS in production environments.
Server-Side Exchange
Always exchange authorization codes from your backend server, never from
client-side code.
Secure Storage
Store client secrets and API keys securely using environment variables or
secret management systems.
Minimal Permissions
Only request the permissions your application actually needs.
Token Characteristics
Quick Links
Exchange Code
Exchange authorization code for API key