Go to home page
Docs API Reference

Applets Memberships

An applet membership represents a user having access to an Applet .

Applet Membership Model

Attributes

  • id

    string

    The unique identifier of the Applet Membership.

  • accountId

    string

    The Account that owns the Applet Membership.

  • createdAt

    timestamp

    When the Applet Membership was created.

  • createdBy

    crn

    The User or API Key that created the Applet Membership.

  • test

    boolean

    true if the Applet Membership is for testing purposes only.

  • appletId

    string

    The unique identifier of the Applet that the membership is for.

  • name

    string

    The display name of the Applet .

  • mediaUploadId

    string

    The id of the Media Upload image of the Applet .

  • img

    string

    The img URL of the Applet .

  • appletAccountId

    string

    The Account that owns the Applet .

  • extensions

    array

    The list of Extensions that are a part of the Applet .

Create Applet Membership experimental

This endpoint allows you to create an Applet Membership .

Request
curl -X POST \
 https://service.centrapay.com/api/applets/WRhAxxWpTKb5U7pXyxQjjY/applet-memberships \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "id": "ad90asd90k12",
  "accountId": "asd901k2e09",
  "appletId": "WRhAxxWpTKb5U7pXyxQjjY",
  "name": "Centrapay Cafe",
  "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
  "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
  "appletAccountId": "Jaim1Cu1Q55uooxSens6yk",
  "createdAt": "2021-08-25T00:02:49.488Z",
  "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
  "extensions": [
    {
      "type": "loyalty",
      "loyaltyProgramId": "L001",
      "getPromotionsUrl": "service.payap.com/api/loyaltyPrograms/L001/promotions",
      "getPromotionMembershipsUrl": "service.payap.com/api/loyaltyPrograms/L001/promotionMemberships",
      "getLoyaltyProgramUrl": "service.payap.com/api/loyaltyPrograms/L001"
    }
  ]
}

List Applet Memberships experimental

Returns a paginated list of Applet Memberships for an Account

Request
curl -X GET \
 'https://service.centrapay.com/api/accounts/Jaim1Cu1Q55uooxSens6yk/applet-memberships?pageKey=eyJzayI6IkFwcGxldE1lbW1dGVMTWNRcEo0NnUifQ%3D%3D&paginationLimit=1' \
 -H 'content-type: application/json' \
 -H 'x-api-key: <TOKEN>'
Response
{
  "nextPageKey": "asxaasd0-l32-1lbW1dGVMTWNRcESDasd9jkSK==",
  "items": [
    {
      "id": "ad90asd90k12",
      "accountId": "asd901k2e09",
      "appletId": "WRhAxxWpTKb5U7pXyxQjjY",
      "name": "Centrapay Cafe",
      "mediaUploadId": "8aoMfscvtuewsuJzmzBzAs",
      "img": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743",
      "appletAccountId": "Jaim1Cu1Q55uooxSens6yk",
      "createdAt": "2021-08-25T00:02:49.488Z",
      "createdBy": "crn::user:b657195e-dc2f-11ea-8566-e7710d592c99",
      "extensions": [
        {
          "type": "loyalty",
          "loyaltyProgramId": "L001",
          "getPromotionsUrl": "service.payap.com/api/loyaltyPrograms/L001/promotions",
          "getPromotionMembershipsUrl": "service.payap.com/api/loyaltyPrograms/L001/promotionMemberships",
          "getLoyaltyProgramUrl": "service.payap.com/api/loyaltyPrograms/L001"
        }
      ]
    }
  ]
}