Library Access

The library access subobjects grant access of groups of titles to ip ranges. It contains two sub objects for managing licenses (what titles) and ip ranges (access from where).

Licenses

https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/licenses lists all configured licenses for a business partner. Each license may be accessed through its id, e.g. https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/licenses/[ID].

Allowed methods GET, PUT and DELETE for each item.

For creating a license POST an object to https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/licenses/.

Fields

Name

name: Arbitrary name for the license. Mandatory field.

Valid From

valid_from: Date from which the access should be granted. Leave as Null for no limitation.

Valid To

valid_to: Date to which the access should be granted. Leave as Null for no limitation.

Example JSON

{
   "_id": 4,
   "name": "Access for MIT",
   "valid_from": "2020-01-01",
   "valid_to": "2020-12-31"
}

IP Ranges

https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/ip_ranges lists all configured ip ranges for a business partner. Each ip range may be accessed through its id, e.g. https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/ip_ranges/[ID].

Allowed methods GET, PUT and DELETE for each item.

For creating an ip range POST an object to https://api.openpublishing.com/resource/v3/business_partners/[ID]/library/ip_ranges/.

Fields

IP From

ip_from: IPv4 or IPv6 from where the ip range should begin. Mandatory field.

IP To

ip_to: IPv4 or IPv6 specifying the upper limit of the IP range. If set to null, ip_from is treated as single IP address.

Type

type: May be set to included or excluded. If set to the latter the IP range is excluded from other included ip ranges.

{
   "_id": 1,
   "ip_from": "10.0.0.2",
   "ip_to": 10.0.0.72,
   "type": "included"
}