{"templateId":"markdown","versions":[{"version":"opendelivery","label":"Open Delivery API","link":"/en/apis/docs/basic-concepts","default":true,"active":true,"folderId":"62a846bf"},{"version":"standard","label":"Standard Keeta API","link":"/en/apis/standard/docs/basic-concepts","default":false,"active":false,"folderId":"62a846bf"},{"version":"grocery","label":"Grocery Keeta API","link":"/en/apis/grocery/docs/basic-concepts","default":false,"active":false,"folderId":"62a846bf"}],"sharedDataIds":{"sidebar":"sidebar-@l10n/en/apis/@opendelivery/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Basic Concepts"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"basic-concepts","__idx":0},"children":["Basic Concepts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PARAMETERS IN THE SOFTWARE SERVICE"]},"   (SOFTWARE SERVICE --> Keeta)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["{baseURL}"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The {baseURL} is the parameter that indicates the base address, i.e. the constant part of the address, where the routes will be called."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["clientId"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["clientSecret"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Keeta"]}," is responsible for providing the credentials for authentication to be performed through the authentication endpoint.",{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IMPORTANT"]},": As described in the authentication section of the documentation, credentials are generated by Keeta, that is, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["if several MERCHANTS use the same Software Service, the software will have a same clientId and clientSecret"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["AppId"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["It is the unique ID of Keeta which is generated by Keeta itself, it will be informed to all the Software Services that it will integrate."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["X-App-Signature"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keeta requires Software Service to generate a signature and include it in the header of each API request. Refer to the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/apis/opendelivery/signature-calculation"},"children":["Signature Calculation"]}," section for the complete algorithm specification."]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["PARAMETERS IN Keeta"]},"    (Keeta --> SOFTWARE SERVICE)"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/en/apis/opendelivery/merchantendpoints/getmerchant"},"children":["GET /merchant"]}," endpoint URL:"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keeta must be provided with the URL to access the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /merchant"]}," route to obtain the merchant's information."]}]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["IMPORTANT"]},": Each merchant that the Software Service works with must have a unique URL."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["apiKey"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If the GET /merchant endpoint is implemented using authentication, it is necessary that the Software Service provides the apiKey referring to the entered merchant."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Order Event Webhook"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If both parties are going to work with sending order events via webhook, it is necessary to provide the URL of the webhook. Default webhook route:  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST {baseURL}/newEvent"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"general-guidelines","__idx":1},"children":["General Guidelines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For general guidelines on the Keeta Open Delivery API, please refer directly to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://abrasel-nacional.github.io/docs/#section/General-Guidelines","target":"_blank"},"children":["Open Delivery General Guidelines"]},"."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"error-handling","__idx":2},"children":["Error Handling"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For error handling guidelines on the Keeta Open Delivery API, please refer directly to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://abrasel-nacional.github.io/docs/#section/Error-Handling","target":"_blank"},"children":["Open Delivery Error Handling"]},"."]}]}]}]},"headings":[{"value":"Basic Concepts","id":"basic-concepts","depth":1},{"value":"General Guidelines","id":"general-guidelines","depth":3},{"value":"Error Handling","id":"error-handling","depth":3}],"frontmatter":{"slug":"/apis/opendelivery/basic-concepts","seo":{"title":"Basic Concepts"}},"lastModified":"2026-11-12T19:24:24.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/en/apis/opendelivery/basic-concepts","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}