Full API documentation for Skylark is available here
The following resources are available to browse on this Skylark installation:
Manage Article Statuses.
Each Article has a single Article Type that can be used to define editorial workflow for Articles. Statuses can be defined on a per-deployment basis but must include at least statuses with slugs "draft" and "published" to act as the initial and final statuses, respectively.
Manage Article Types.
Each Article has a single Article Type that can be used to classify or categorise Articles.
Handle any webhook callbacks from configured payment providers.
Client applications should not call this API.
A standard CRUD resource for Card if not for the create method.
The creation of the card is not done by create, which merely asks the
subscription service to create the card.
A standard CRUD resource for BasicEmailUser if not for a Urban Airship specific feature, support for SocialAuthentication and user Anonymisation.
The urban airship feature is an endpoint to link a user with a Urban
Airship profile (see docs/urban_airship.md). The user is also unlinked from
Urban Airship when it is disabled (see
associate_user_and_channel_id_in_urban_airship, delete).
As for the social authentication support, the creation of a user with an
email linked to a user profile triggers a 409. The assumption is that the
user already exists on a social authentication platform. (see create)
A user is anonymized when disabled (see delete).
A standard CRUD resource for CustomerEntitlement if not for its list and
create method.
The list method can be called by two different URLs (see list).
The create method does a fair bit of parsing and validation before creating
the CustomerEntitlement. It offers three ways of creating a
CustomerEntitlement (see create).
A standard CRUD resource for Discount.
A standard CRUD resource for PaymentMethodType if not for the redirection to the payment page.
Indeed, on redirection to the payment provider, it supports setting where
the user will land after their payment. See redirect() for more details.
A standard CRUD resource for Plan if not for its prefetching of related Schedules, Entitlement, PricePoint and content.
A standard CRUD resource for Entitlement.
A standard CRUD resource for PricePoints.
A standard CRUD resource for Promotion if not for two deviations:
create)/validate/ (see
validate)A CRUD resource for Subscription.
Every one of its methods is extended compared to those of a normal CRUD resource, please see their respective documentation.
This resource only lists Transactions.
A standard CRUD resource for UserPaymentMethodResource if not for the
create method. It uses two forms, the second form chosen from the first
one.
A standard CRUD resource for Viewing if not for its create method.
The create method can create a Viewing for various content types. It also
check if a user has a permission to view the content, tunes how a Viewing
is saved to database, and return a tokenized url for the stream to the user
(See create).
Sets are generic ordered container objects, containing Scheduled Items
Ad slot types are used to place adverts with editorially controlled placement or targeting data.
Ad-by-ad metadata, such as a slot identifier, is provided whe the ad is
scheduled into a containing Set. The default metadata field available
when scheduling an ad into a set is name.
Blanks are typically used to create space in page layouts.
Dividers are generally used to create headings, navigation items, or placeholders.
Skylark configurations generally treat this object as a divider type, with divider-by-divider appearance and content metadata stored when the divider is scheduled into a containing Set.
Link Types are used to place hyperlinks to content, typically outside the client application.
Link-by-link destination, content and appearance information is stored when
the link type is scheduled into a containing Set. The default metadata
fields available when scheduling a link into a set are url, title
and synopsis.
Quotes are used to contain attributed quotation data.
Social card types are used to represent posts or conversations that should be represented in the client application. Each social card type represents a particular source of embeddable content.
Post-by-post identifiers are stored when the social card is scheduled
into a containing Set. The default metadata field available when
scheduling a social card into a set is social_id.
Text Blocks are used to create short-form textual content.
Skylark configurations generally treat this object as a text block type, with block-by-block appearance and copy metadata stored when the text block is scheduled into a containing Set.
For longer-form rich text, consider the Articles API instead.
Manage Devices for a user.
Device tracking is dependant on an integration with an OVP that provides this functionality.
Each Tag belongs to a single Tag Category.
Tags in Skylark are structured and categorised. They can be applied to several entities in the system, including Sets and TV Content, and used for subsequent filtering.
Tags do not have schedules, but they can be applied to TV Content with a schedule.
Returns Django groups
View user permissions.
A authenticated user can view their own permissions. A user with 'read_permission_resource' permissions can view any users permissions.