Skip to content
Navigation

Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers `conflict` on `items`, and a license that is not active `conflict` on `status`.

POST
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/licenses/activate

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1

Request body JSON required

  • key
    string
    required

    The key as the customer typed it.

    maxLength: 128 · minLength: 1
  • instance
    string
    required

    A stable id of the device or seat, chosen by the software; only its keyed digest is kept.

    maxLength: 256 · minLength: 1
  • name
    optional
    string

    What the holder and the merchant see it as, such as the device's name.

    maxLength: 480 · minLength: 1

Returns

200

Counts a device toward a software product's license from the seller's server, or refreshes one it already counts, and answers a signed token the software checks offline; past the license's activation limit (10,000 when nothing limits it) it answers conflict on items, and a license that is not active conflict on status.

JSON
  • activations
    object
    required
    • count
      number
      required
    • limit
      required

      One of the following:

      • number
      • null
  • activation
    object
    required
    • id
      string
      required
    • license_id
      string
      required
    • name
      required

      One of the following:

      • string
      • null
    • status
      string
      required

      active counts toward the limit; inactive went unseen past the product's inactive days; deactivated was freed.

    • created_at
      string
      required
    • activated_at
      string
      required
    • last_seen_at
      string
      required
    • deactivated_at
      required

      One of the following:

      • string
      • null
    • deactivated_by
      required

      Who freed it: customer, merchant or software; null while not freed.

      One of the following:

      • string
      • null
  • token
    string
    required

    A compact JWS (EdDSA) the software checks offline against the store's published signing keys.

  • token_expires_at
    string
    required

    When the token stops verifying: the earliest of the product's offline window and the end of the access it carries.

JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close