Readers
Last updated
Last updated
API for managing app readers
GET
https://www.magloft.com/api/portal/v1/readers/:app_id
This endpoint returns a list of all readers
that belong to the magazine
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
GET
https://www.magloft.com/api/portal/v1/readers/:app_id/page/:page
This endpoint returns a page list of all readers
that belong to the magazine
GET
https://www.magloft.com/api/portal/v1/readers/:app_id/(:email)(:id)
This endpoint returns a specific reader
by id
POST
https://www.magloft.com/api/portal/v1/readers/:app_id
This endpoint creates a new reader
and returns the saved reader
PUT
https://www.magloft.com/api/portal/v1/readers/:app_id/:id
This endpoint updates a specific reader
by id
and returns the updated reader
DELETE
https://www.magloft.com/api/portal/v1/readers/:app_id/:id
This endpoint deletes a specific reader
by id
and returns an empty response
with status 204
POST
https://www.magloft.com/api/portal/v1/readers/:app_id/:id/unlock
This endpoint creates one or many issue purchases
by product_id
and returns a list of issue purchases
POST
https://www.magloft.com/api/portal/v1/readers/:app_id/:id/unlock/coupon
This endpoint unlock one issue
by coupon
and returns a list of issue purchases
GET
https://www.magloft.com/api/portal/v1/readers/:app_id/export.csv
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
app_id
String
App ID (Publication) to scope this request for.
debug
Virtus::Attribute::Boolean
app_id
String
App ID (Publication) to scope this request for.
page
Integer
The page number to list
per_page
Integer
Number of items to show per page
order_by
Symbol
Field to sort results by
order_dir
Symbol
Direction (asc, desc) to sort results by
filter
JSON
app_id
String
App ID (Publication) to scope this request for.
String
Reader Email Address
id
Integer
Reader ID
app_id
String
App ID (Publication) to scope this request for.
String
Reader Email Address
password
String
Reader Password
name
String
Reader First Name
lastname
String
Reader Last Name
custom_data
Hash
Custom key-value data stored for this reader
confirmation
Virtus::Attribute::Boolean
Send Confirmation Email
confirmed
Virtus::Attribute::Boolean
Whether this readers' Email was confirmed
classification_ids
Array
Reader Classification IDs
app_id
String
App ID (Publication) to scope this request for.
id
Integer
Reader ID
name
String
Reader First Name
lastname
String
Reader Last Name
String
Reader Email Address
custom_data
Hash
Custom key-value data stored for this reader
password
String
Reader Password
confirmed
Virtus::Attribute::Boolean
Whether this readers' Email was confirmed
classification_ids
Array
Reader Classification IDs
app_id
String
App ID (Publication) to scope this request for.
id
Integer
Reader ID
app_id
String
App ID (Publication) to scope this request for.
id
Integer
Reader ID
product_ids
Array
Array containing Issue Product IDs to unlock
order_id
String
Subscription Order ID
app_id
String
App ID (Publication) to scope this request for.
id
Integer
Reader ID
issue_id
Integer
article_id
Integer
code
String
app_id
String
App ID (Publication) to scope this request for.