LCP License Server API documentation

http://localhost:8989

/contents

get put

Contents

get

This method fetches the encrypted publication stored by the License Server

put

Store the data resulting from an external encryption

This method fetches the encrypted publication stored by the License Server

URI Parameters

  • content-id: required(string)

HTTP status code 200

Content found

HTTP status code 404

File not found

HTTP status code 500

Internal server error

Store the data resulting from an external encryption

URI Parameters

  • content-id: required(string)

Body

Media type: application/json

Type: object

Properties
  • content-id: required(string)
  • content-encryption-key: required(string)
  • protected-content-location: required(string)
  • protected-content-length: required(string)
  • protected-content-sha256: required(string)
  • protected-content-disposition: required(string)

Example:

{
  "content-id" : "<value>",
  "content-encryption-key" : "<value>",
  "protected-content-location" : "<value>",
  "protected-content-length" : "<value>",
  "protected-content-sha256" : "<value>",
  "protected-content-disposition" : "<value>"
}

HTTP status code 200

content found (OK

HTTP status code 201

the content was added (created)

HTTP status code 400

bad request (File not saved)

HTTP status code 401

unauthorized

HTTP status code 404

not found

HTTP status code 500

Internal server error

post

post

Generate a license

Generate a license

URI Parameters

  • content-id: required(string)

Body

Media type: application/json

Type: object

Properties
  • provider: required(string)
  • user: required(object)
    • id: required(string)
    • email: required(string)
    • encrypted: required(array of any)
  • encryption: required(object)
    • user_key: required(object)
      • text_hint: required(string)
      • hex_value: required(string)
  • rights: required(object)
    • print: required(integer)
    • copy: required(integer)
    • start: required(datetime)
    • end: required(datetime)

Example:

{
    "provider": "https://lcp.dev.medialibrary.it",
    "user": {
        "id": "67E97749-0B8D-466B-BA91-4E7163F023D9",
        "email": "raffaele@example.com",
        "encrypted": [
            "email"
        ]
    },
    "encryption": {
        "user_key": {
            "text_hint": "favourite beer",
            "hex_value": "0cf7283b17dd99bd946c13f82ddb138f7316d7d9e9622403ed66329b47b9e130"
        }
    },
    "rights": {
        "print": 10,
        "copy": 2048,
        "start": "2020-01-01T01:08:15+01:00",
        "end": "2020-02-10T01:08:15+01:00"
    }
}

post

post

Generate a licensed publication

Generate a licensed publication

URI Parameters

  • content-id: required(string)

Body

Media type: application/json

Type: object

Properties
  • provider: required(string)
  • user: required(object)
    • id: required(string)
    • email: required(string)
    • encrypted: required(array of any)
  • encryption: required(object)
    • user_key: required(object)
      • text_hint: required(string)
      • hex_value: required(string)
  • rights: required(object)
    • print: required(integer)
    • copy: required(integer)
    • start: required(datetime)
    • end: required(datetime)

Example:

{
    "provider": "https://lcp.dev.medialibrary.it",
    "user": {
        "id": "67E97749-0B8D-466B-BA91-4E7163F023D9",
        "email": "raffaele@example.com",
        "encrypted": [
            "email"
        ]
    },
    "encryption": {
        "user_key": {
            "text_hint": "favourite beer",
            "hex_value": "0cf7283b17dd99bd946c13f82ddb138f7316d7d9e9622403ed66329b47b9e130"
        }
    },
    "rights": {
        "print": 10,
        "copy": 2048,
        "start": "2020-01-01T01:08:15+01:00",
        "end": "2020-02-10T01:08:15+01:00"
    }
}

get

get

This method returns a sequence of partial licenses, in ante-chronological order (on date of issue).

This method returns a sequence of partial licenses, in ante-chronological order (on date of issue).

URI Parameters

  • content-id: required(string)

/licenses

This method returns a sequence of partial licenses, in ante-chronological order (on date of issue).

post patch

post

This method returns a license, using its identifier as key.

patch

This method can force the update of the information stored in the License Server database, I.e. The license provider The user identifier the rights associated with a license It is usually called from the License Status server (for lending return or renewal), and in this case only contains a rights object.

This method returns a license, using its identifier as key.

URI Parameters

  • license_id: required(string)

This method can force the update of the information stored in the License Server database, I.e. The license provider The user identifier the rights associated with a license It is usually called from the License Status server (for lending return or renewal), and in this case only contains a rights object.

URI Parameters

  • license_id: required(string)

post

This method returns a licensed publication, using its license identifier as key.

post

URI Parameters

  • license_id: required(string)