🚀Create an Application

Guide to creating your first application

App Types

• Private Available to you and your sub accounts (if Agency tariff), moderation-free

• Public Available to all users of the platform after moderation

To integrate with the Marketplace, you need to implement a separate application service that communicates with both the POS system and the Marketplace.

This service must expose several endpoints that the Marketplace will interact with.

App Endpoints

Check Credentials

post

This method is used to verify the user credentials specified when installing the application.

Body

application/json

Responses

200

Successful response

application/json

isValidboolean · nullableOptional

post

/check-credentials

HTTPcURLJavaScriptPython

POST /check-credentials HTTP/1.1
Host: app-domain.example
Content-Type: application/json
Accept: */*
Content-Length: 113

[
  {
    "name": "merchantId",
    "value": "8481654933"
  },
  {
    "name": "accessToken",
    "value": "M0MTAsImV4cCI6MTcyNjEzNzAxMCwicm9sZ"
  }
]

200

Successful response

{
  "isValid": true
}

Get Inventory

post

This method is used to retrieve an inventory tree (for example, a restaurant menu). The method is used during application installation and when inventory-based rules are triggered.

Body

application/json

Responses

200

Successful response

application/json

post

/get-inventory

HTTPcURLJavaScriptPython

POST /get-inventory HTTP/1.1
Host: app-domain.example
Content-Type: application/json
Accept: */*
Content-Length: 113

[
  {
    "name": "merchantId",
    "value": "8481654933"
  },
  {
    "name": "accessToken",
    "value": "M0MTAsImV4cCI6MTcyNjEzNzAxMCwicm9sZ"
  }
]

200

Successful response

{
  "inventoryItems": [
    {
      "type": "group",
      "id": "123",
      "title": "Group 1",
      "items": [
        {
          "type": "item",
          "id": "1234",
          "title": "Item 1"
        }
      ]
    }
  ]
}

---

Example app for marketplace

GitHub - BoomerangmeInc/marketplace-app-example: GloriaFood example app for Boomerangme marketplaceGitHub

---

Marketplace API Documentation

https://docs.dev.boomerangme.cards/#tag/Marketplace-API

Check credentials

post

Retrieve a bundle of app installation credentials using any one of them.

For example, on a service webhook or at the application service level, you may only have the merchant ID and need to obtain the service API token.

Header parameters

X-App-TokenstringRequired

App static authorization token

Body

application/json

namesstring[]Required

Optional credential names to return. If not specified, all merchant credentials are returned.

Responses

200

Successful response

application/json

400

Bad request

application/json

403

Authentication failed

application/json

post

/api/v2/marketplace/resolve-credentials

HTTPcURLJavaScriptPython

POST /api/v2/marketplace/resolve-credentials HTTP/1.1
Host: api.digitalwallet.cards
X-App-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "names": [
    "text"
  ],
  "credentials": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

{
  "credentials": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

Accrual action

post

Perform an accrual action on a purchase.

A customer's phone number, email, or card serial number is required to find or register a loyalty card.

Header parameters

X-App-TokenstringRequired

App static authorization token

Body

application/json

checkone of · nullableRequired

phonestring · nullableOptional

Customer's phone.

emailstring · nullableOptional

Customer's email.

firstNamestring · nullableOptional

Customer's first name.

lastNamestring · nullableOptional

Customer's last name.

serialNumberstring · nullableOptional

Customer's loyalty card serial number.

transactionIdstring · nullableRequired

Unique transaction id.

Responses

200

Successful response

application/json

transactionIdstringRequired

400

Bad request

application/json

403

Authentication failed

application/json

post

/api/v2/marketplace/accrue

HTTPcURLJavaScriptPython

POST /api/v2/marketplace/accrue HTTP/1.1
Host: api.digitalwallet.cards
X-App-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 496

{
  "check": {
    "amount": 1,
    "externalTransactionId": "text",
    "checkOpenedAt": "text",
    "checkClosedAt": "text",
    "taxAmount": 1,
    "discountAmount": 1,
    "tipAmount": 1,
    "serviceAmount": 1,
    "totalTipReceived": "text",
    "orderUpdatedAt": "text",
    "currency": "text",
    "selections": [
      {
        "id": "text",
        "groupId": "text",
        "displayName": "text",
        "price": 1,
        "quantity": 1,
        "totalPrice": 1
      }
    ]
  },
  "phone": "text",
  "email": "text",
  "firstName": "text",
  "lastName": "text",
  "serialNumber": "text",
  "transactionId": "text",
  "credentials": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

{
  "transactionId": "text",
  "results": [
    {
      "installationId": 1,
      "templateId": 1,
      "companyId": 1,
      "isSuccess": true,
      "errorMessage": "text",
      "cardType": 1,
      "serialNumber": "text",
      "checkAmount": 1,
      "accrualAmount": 1,
      "accruedValue": 1,
      "operationId": 1,
      "createdAt": "text",
      "reversedAt": "text"
    }
  ]
}

Refund action

post

Revert a previously performed accrual action using the transaction ID.

Header parameters

X-App-TokenstringRequired

App static authorization token

Body

application/json

transactionIdstring · nullableRequired

Unique transaction id.

Responses

200

Successful response

application/json

transactionIdstringRequired

400

Bad request

application/json

403

Authentication failed

application/json

post

/api/v2/marketplace/reverse

HTTPcURLJavaScriptPython

POST /api/v2/marketplace/reverse HTTP/1.1
Host: api.digitalwallet.cards
X-App-Token: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "transactionId": "text",
  "credentials": [
    {
      "name": "text",
      "value": "text"
    }
  ]
}

{
  "transactionId": "text",
  "results": [
    {
      "installationId": 1,
      "templateId": 1,
      "companyId": 1,
      "isSuccess": true,
      "errorMessage": "text",
      "cardType": 1,
      "serialNumber": "text",
      "checkAmount": 1,
      "accrualAmount": 1,
      "accruedValue": 1,
      "operationId": 1,
      "createdAt": "text",
      "reversedAt": "text"
    }
  ]
}

Once you have all the data, you can add your application to the Boomerang marketplace.

To do this, go to the Settings -> Apps tab and click “Create App.”

Enter the name and description of the application.

Enter the URLs for checking credits (required), obtaining a list of products, and Webhook Postback after installation.

Set whether your application will be public (accessible to all users) or not (accessible only to you and your sub-accounts).

Select which accrual rules will be available in your application.

Add the fields required to connect the application:

Field name for API - the name of the field used in the API

Field title for UI - the name of the field that will be displayed in the interface.

Add a description that will also be reflected in the interface.

After adding a public application, you need to submit it for moderation.