{"templateId":"markdown","versions":[{"version":"opendelivery","label":"Open Delivery API","link":"/apis/opendelivery/docs/selfauthor","default":true,"active":false,"folderId":"58c9a61d"},{"version":"standard","label":"Standard Keeta API","link":"/apis/standard/docs/selfauthor","default":false,"active":false,"folderId":"58c9a61d"},{"version":"grocery","label":"Grocery Keeta API","link":"/apis/grocery/docs/selfauthor","default":false,"active":true,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@grocery/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Merchant Self-Authorization Integration Guide","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"merchant-self-authorization-integration-guide","__idx":0},"children":["Merchant Self-Authorization Integration Guide"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Merchant self-authorization is an authorization mechanism based on the OAuth 2.0 protocol. It enables developers to facilitate merchant authorization through a standardized process, without contacting the Keeta team for manual processing. The entire authorization process is secure and efficient."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keeta provides two integration modes for developers who need automated token acquisition:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server Callback Mode:"]}," Keeta pushes the authorization code directly to a Webhook URL via HTTP GET. This mode is suitable for vendors who do not have merchant-facing frontend pages."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Standard OAuth 2.0 Mode:"]}," Keeta redirects the merchant's browser to a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," developers specify in the authorization link, carrying the authorization code as a query parameter. This mode is suitable for developers who have their own frontend pages and want merchants to land on their system after completing authorization."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following sections walk through each mode in detail, covering the full authorization workflow and integration steps."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Related APIs & Webhooks"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following APIs and Webhook events are involved in this flow. Refer to the linked references for request parameters, response fields, and signature verification details."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Authorization Code Notification Webhook(Event ID: 1):"]}," The Webhook notification, bringing auth code, sent by Keeta to the vendor's configured Webhook URL after merchant authorization. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/webhooks/oauth2authorizationcodenotification"},"children":["View reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get Token API:"]}," Exchange the authorization code for an access token and refresh token. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/endpoints/oauthtoken"},"children":["View reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get Merchant Authorization Information API:"]}," Retrieve the brand ID and authorized store list after obtaining the access token. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/endpoints/getauthorizedresources"},"children":["View reference"]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"server-callback-mode","__idx":2},"children":["Server Callback Mode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In Server Callback Mode, the authorization code is delivered server-to-server. The developer configures a Webhook URL for Event ID 1 in the Developer Portal, then generates an authorization link and provides it to the merchant. After the merchant completes authorization on the Keeta merchant platform, Keeta sends the authorization code directly to the configured Webhook URL via HTTP GET. The developer's backend receives the code and exchanges it for an access token — no frontend page is involved on the developer's side."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configuring the webhook URL"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the Developer Portal, open ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Application Management / Edit Application"]},". Under Push Oauth2 authorization code, enter the redirect URL in the Webhook URL field. This is the base domain Keeta will redirect to after merchant authorization."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/selfauthor10.535f02ce16cb500f4fc4c20c17e713a9853b06d11235d4fbade645fd0512f6ae.39f28274.png","alt":"image.png"},"children":[]}," ",{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/selfauthor11.510d8959163a9aa0f73374018f7fb7997fbe179f55862c2b3f239b76ee2397ca.39f28274.png","alt":"image.png"},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Merchant as Merchant\n participant DevServer as Vendor\n participant Keeta as Keeta Open Platform\n participant KeetaMerchant as Keeta Merchant Portal\n\n DevServer->>Keeta: Configure Webhook URL for Event ID 1 in Developer Portal\n DevServer->>Merchant: Send OAuth authorization link\n Merchant->>KeetaMerchant: Authorize account and select stores\n KeetaMerchant->>Keeta: Forward authorization confirmation\n Keeta->>DevServer: Send auth code via Webhook (Event ID 1)\n DevServer->>Keeta: Exchange auth code for access token (POST /base/oauth/token)\n Keeta-->>DevServer: Issue access token\n DevServer->>Keeta: Get brand ID / authorized stores (GET /api/open/base/authorized/resource/get)\n Keeta-->>DevServer: Return authorized stores\n DevServer->>DevServer: Map Keeta stores in vendor system\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant Merchant as Merchant\n participant DevServer as Vendor\n participant Keeta as Keeta Open Platform\n participant KeetaMerchant as Keeta Merchant Portal\n\n DevServer->>Keeta: Configure Webhook URL for Event ID 1 in Developer Portal\n DevServer->>Merchant: Send OAuth authorization link\n Merchant->>KeetaMerchant: Authorize account and select stores\n KeetaMerchant->>Keeta: Forward authorization confirmation\n Keeta->>DevServer: Send auth code via Webhook (Event ID 1)\n DevServer->>Keeta: Exchange auth code for access token (POST /base/oauth/token)\n Keeta-->>DevServer: Issue access token\n DevServer->>Keeta: Get brand ID / authorized stores (GET /api/open/base/authorized/resource/get)\n Keeta-->>DevServer: Return authorized stores\n DevServer->>DevServer: Map Keeta stores in vendor system\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"standard-oauth-20-authorization-mode","__idx":3},"children":["Standard OAuth 2.0 Authorization Mode"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In Standard OAuth 2.0 Mode, the authorization code is delivered via browser redirect. The developer would need to concatenate an authorization link with a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," parameter and distribute to merchants. After the merchant completes authorization on the Keeta merchant platform, Keeta redirects the merchant's browser to the specified ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," with the authorization code appended as a query parameter. The developer's frontend page captures the code and passes it to the backend to exchange for an access token."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Concatenating the authorization link"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The base authorization link can be obtained by clicking ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Add Authorization"]}," on the Application Management page. The developer then appends ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," to the link before sending it to the merchant."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Base link:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"merchant.mykeeta.com/m/web/openapi/authorize?responseType=authorization_code&appId=YOUR_APP_ID&redirectUri=&state=&scope=all\n"},"children":[]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Modified link (with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," filled in, parameter order does not matter):"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"header":{"controls":{"copy":{}}},"source":"merchant.mykeeta.com/m/web/openapi/authorize?responseType=authorization_code&appId=YOUR_APP_ID&redirectUri=https://your-site.com/auth/callback&state=YOUR_STATE&scope=all\n"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," is the exact page on the developer's site where the merchant should land after authorization. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["state"]}," is an opaque value defined by the developer, returned unchanged by Keeta, useful for identifying which merchant or session initiated the flow."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configuring the redirect URL"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Keeta requires vendor developers to configure the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redirectUri"]}," under the Push Oauth2 authorization code for security purposes."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/selfauthor11.510d8959163a9aa0f73374018f7fb7997fbe179f55862c2b3f239b76ee2397ca.39f28274.png","alt":"image.png"},"children":[]}," ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Workflow"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Merchant as Merchant\n participant DevFrontend as Vendor Frontend\n participant DevServer as Vendor Backend\n participant Keeta as Keeta Open Platform\n participant KeetaMerchant as Keeta Merchant Portal\n\n DevServer->>Keeta: Configure redirect URL in Developer Portal\n DevFrontend->>Merchant: Send OAuth authorization link (with redirectUri & state)\n Merchant->>KeetaMerchant: Authorize account and select stores\n KeetaMerchant->>Keeta: Forward authorization confirmation\n Keeta-->>Merchant: Redirect browser to redirectUri?code=AUTH_CODE&state=...\n Merchant->>DevFrontend: Browser lands on redirectUri with auth code\n DevFrontend->>DevServer: Pass auth code to backend\n DevServer->>Keeta: Exchange auth code for access token (POST /base/oauth/token)\n Keeta-->>DevServer: Issue access token\n DevServer->>Keeta: Get brand ID / authorized stores (GET /api/open/base/authorized/resource/get)\n Keeta-->>DevServer: Return authorized stores\n DevServer->>DevServer: Map Keeta stores in vendor system\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant Merchant as Merchant\n participant DevFrontend as Vendor Frontend\n participant DevServer as Vendor Backend\n participant Keeta as Keeta Open Platform\n participant KeetaMerchant as Keeta Merchant Portal\n\n DevServer->>Keeta: Configure redirect URL in Developer Portal\n DevFrontend->>Merchant: Send OAuth authorization link (with redirectUri & state)\n Merchant->>KeetaMerchant: Authorize account and select stores\n KeetaMerchant->>Keeta: Forward authorization confirmation\n Keeta-->>Merchant: Redirect browser to redirectUri?code=AUTH_CODE&state=...\n Merchant->>DevFrontend: Browser lands on redirectUri with auth code\n DevFrontend->>DevServer: Pass auth code to backend\n DevServer->>Keeta: Exchange auth code for access token (POST /base/oauth/token)\n Keeta-->>DevServer: Issue access token\n DevServer->>Keeta: Get brand ID / authorized stores (GET /api/open/base/authorized/resource/get)\n Keeta-->>DevServer: Return authorized stores\n DevServer->>DevServer: Map Keeta stores in vendor system\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"managing-authorization-changes","__idx":4},"children":["Managing Authorization Changes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once a merchant has completed authorization, they can manage the authorized store scope at any time through the Keeta Merchant Portal: adding stores, removing stores, or fully revoking brand authorization. Keeta notifies the vendor's system of these changes in real time via Webhook, so the vendor can keep its local store mapping synchronized."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Vendors who have integrated merchant self-authorization ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["should subscribe to these events"]}," to ensure their system always reflects the current authorized store scope."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Store Authorization Change (Event ID 1301 / 1302)"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Merchant as Keeta Merchant Portal\n participant Keeta as Keeta Open Platform\n participant VendorWebhook as Vendor Webhook Endpoint\n participant VendorDB as Vendor Local Auth Data\n\n Merchant->>Keeta: Add / remove store authorization\n Keeta->>Keeta: Update authorization record and store mapping\n\n alt Add store authorization\n Keeta->>VendorWebhook: POST authorization change notification (Event ID 1301)\n else Remove store authorization\n Keeta->>VendorWebhook: POST authorization change notification (Event ID 1302)\n end\n\n VendorWebhook->>VendorWebhook: Parse appId / shopId / shopName / authId / createTime / opType\n VendorWebhook->>VendorDB: Update local store authorization mapping\n VendorDB-->>VendorWebhook: Update complete\n VendorWebhook-->>Keeta: HTTP 200\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant Merchant as Keeta Merchant Portal\n participant Keeta as Keeta Open Platform\n participant VendorWebhook as Vendor Webhook Endpoint\n participant VendorDB as Vendor Local Auth Data\n\n Merchant->>Keeta: Add / remove store authorization\n Keeta->>Keeta: Update authorization record and store mapping\n\n alt Add store authorization\n Keeta->>VendorWebhook: POST authorization change notification (Event ID 1301)\n else Remove store authorization\n Keeta->>VendorWebhook: POST authorization change notification (Event ID 1302)\n end\n\n VendorWebhook->>VendorWebhook: Parse appId / shopId / shopName / authId / createTime / opType\n VendorWebhook->>VendorDB: Update local store authorization mapping\n VendorDB-->>VendorWebhook: Update complete\n VendorWebhook-->>Keeta: HTTP 200\n"]},{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Brand Authorization Removal (Event ID 1303)"]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant Merchant as Keeta Merchant Portal\n participant Keeta as Keeta Open Platform\n participant VendorWebhook as Vendor Webhook Endpoint\n participant VendorDB as Vendor Local Auth Data\n\n Merchant->>Keeta: Revoke brand authorization\n Keeta->>Keeta: Update authorization record\n Keeta->>VendorWebhook: POST brand authorization removal notification (Event ID 1303)\n VendorWebhook->>VendorDB: Invalidate access token and mark all stores as unauthorized\n VendorDB-->>VendorWebhook: Update complete\n VendorWebhook-->>Keeta: HTTP 200\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant Merchant as Keeta Merchant Portal\n participant Keeta as Keeta Open Platform\n participant VendorWebhook as Vendor Webhook Endpoint\n participant VendorDB as Vendor Local Auth Data\n\n Merchant->>Keeta: Revoke brand authorization\n Keeta->>Keeta: Update authorization record\n Keeta->>VendorWebhook: POST brand authorization removal notification (Event ID 1303)\n VendorWebhook->>VendorDB: Invalidate access token and mark all stores as unauthorized\n VendorDB-->>VendorWebhook: Update complete\n VendorWebhook-->>Keeta: HTTP 200\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To receive these notifications, configure a callback URL for each event in the Developer Portal under ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit Application → Webhook Configuration"]},"."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When a merchant adds stores to an existing brand authorization, Keeta sends ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event ID 1301"]},". ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/webhooks/storeauthorizationnotification"},"children":["View reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When a merchant removes stores from an existing brand authorization, Keeta sends ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event ID 1302"]},". ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/webhooks/storeauthorizationremovalnotification"},"children":["View reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["When a merchant fully revokes authorization for a brand, Keeta sends ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event ID 1303"]},". Upon receiving this notification, the vendor's system should treat the associated access token as invalid. ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/apis/standard/basic/webhooks/brandauthorizationremovalnotification"},"children":["View reference"]}]}]}]},"headings":[{"value":"Merchant Self-Authorization Integration Guide","id":"merchant-self-authorization-integration-guide","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Server Callback Mode","id":"server-callback-mode","depth":2},{"value":"Standard OAuth 2.0 Authorization Mode","id":"standard-oauth-20-authorization-mode","depth":2},{"value":"Managing Authorization Changes","id":"managing-authorization-changes","depth":2}],"frontmatter":{"seo":{"title":"Merchant Self-Authorization Integration Guide"}},"lastModified":"2026-07-15T11:32:09.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/grocery/docs/selfauthor","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}