Appearance

Products ​

Products are what you will be granting access to when issuing a license.

Get all products ​

Endpoint: GET https://api.software-licensing.io/v1/products

Parameters(Query) ​

ts
pageSize?: integer
ts
pageNumber?: integer
ts
search: {
}
ts
sort_by?: string[]

Responses ​

  • 200 Success

application/json

ts
{
  data: {
    id: string
    name: string
    deactivated: boolean
  }[]
  pagination: {
    itemCount: integer
    totalPages: integer
    currentPage: integer
    nextPage?: integer
    previousPage?: integer
  }
}

Create a product ​

Endpoint: POST https://api.software-licensing.io/v1/products

Product name has to be unique.

RequestBody ​

ts
{
  name: string
}

Responses ​

  • 201 Returns created product.

application/json

ts
{
  id: string
  name: string
  deactivated: boolean
}

Get a product ​

Endpoint: GET https://api.software-licensing.io/v1/products/product/{id}

Responses ​

  • 200 Success

application/json

ts
{
  id: string
  name: string
  deactivated: boolean
}

Update a product ​

Endpoint: PUT https://api.software-licensing.io/v1/products/product/{id}

RequestBody ​

ts
{
  name?: string
  deactivated?: boolean
}

Responses ​

  • 204 Product was updated successfully