Mavenseed Documentation
Back to Mavenseed
  • Welcome to Mavenseed 🎉
  • Getting Started
    • Creating your account
      • Connect to Stripe
        • Stripe F.A.Q.
    • Managing your account
      • Managing Your Sites
        • Custom Domains
        • Importing Data
          • Customers with subscriptions
          • Customers with orders
          • Customers with no orders
          • Courses
          • Videos
          • Images
        • Exporting Data
        • Gateways
        • Policies
      • Inviting Collaborators
      • Guest Authors
      • Manage your Subscription
      • Plugin Subscriptions
  • Creating Content
    • Dashboard
    • Posts
      • Quotes
    • Pages
    • Courses
      • Course Stats
      • Chapters: Adding & Editing
      • Lessons
      • Exercises (Assignments)
        • Submitting to an Exercise
      • Quizzes
      • Details
      • Selling Options
      • Course Files
      • Settings
      • Notes
      • Revisions
    • Community
      • Buzzes
    • Downloads
      • Edit
      • Sell
      • Files
    • Live Streams
      • Editing Details
      • Selling Options
      • Editing Media
      • RSVP's
    • Categories
    • Tags
    • Site Search
    • Page Builder
      • Using Templates
    • Media Library
  • Selling Your Content
    • Single Purchases
    • Bundles
    • Memberships
    • Selling FAQ
    • SCA
  • Running your business
    • Customers
      • Received Payments
    • Progress Reports
    • Orders
      • Creating Manual Orders
    • Managing Subscriptions
      • How Subscriptions Work
      • Creating Subscription Plans
      • Editing a Subscription Plan
      • Canceling & or Deleting customers subscription
      • How to: Creating a tiered subscription offering
      • Changing your Maven Subscription Plan
      • Emailing your Subscribers
      • Team Plans
      • Override Plans Page
      • Custom Welcome Page
      • Free Subscriptions
    • Coupons
    • Gift Cards
    • Gift Subscriptions
    • GDPR
    • Selling Merch
  • Managing your site
    • Activity
      • Events List
      • Single Event
      • UTM Campaigns
      • Comments
    • Reports
    • Settings
      • Scripts
      • Links
      • Design
      • Communications
      • Integrations
        • Google Analytics
        • Google Tag Manager
        • Mailchimp
        • Zapier
        • Youtube
        • Helpscout
        • Tree Planting
      • Taxes
        • Stripe
        • Braintree
        • U.S. Sales Tax
        • EU Value Added Tax
      • Forms
        • Contact form
    • Market
      • Social Links
      • Social
      • Comments
      • Reviews
      • Bookmarks
      • Loves
      • Playlists
      • Gamification
      • PayPal ($)
      • Projects ($)
      • Profiles ($)
    • Security
      • Spam
    • Notifications
    • SEO
  • Developers
    • API
      • Coupons
      • Courses
      • Customers
      • Events
      • Lessons
      • Chapters
      • Course Chapters
      • Orders
      • Payments
      • Subscriptions
    • Webhooks
    • Site Customizations
  • Changelog
    • 2023
      • January
    • 2022
      • December 2022
      • November 2022
      • October 2022
      • September 2022
      • August 2022
      • July 2022
      • May 2022
      • April 2022
      • March 2022
      • February 2022
      • January 2022
    • 2021
      • November 2021
      • September 2021
      • August 2021
      • July 2021
      • June 2021
      • May 2021
      • February 2021
      • January 2021
    • 2020
      • November 2020
      • October 2020
      • September 2020
      • August 2020
      • July 2020
      • June 2020
      • May 2020
      • April 2020
  • Beta Accounts
    • Ensuring Subscription Plans are Synced with Stripe
    • Updating your Stripe Product ID
Powered by GitBook
On this page
  • All Lessons
  • Show Lesson
  • Create Lesson
  • Update Lesson
  • Delete a Lesson

Was this helpful?

Export as PDF
  1. Developers
  2. API

Lessons

All Lessons

GET https://yoursite.mavenseed.com/api/v1/lessons

Retrieve all lessons

Path Parameters

Name
Type
Description

page

integer

Results are paginated.

Headers

Name
Type
Description

Authorization

string

Auth token

[
    {
        "id": 25,
        "lessonable_type": "Chapter",
        "lessonable_id": 9,
        "title": "Lighting Window",
        "slug": "lighting-window",
        "content": "In this lesson we'll take a look at the lighting window. In this window we can adjust various global illumination settings such as ambient light, lightmaps, and light \"bounce\". This window will become invaluable to adjusting the overall light within your game. To learn more about the lighting window click here: http://docs.unity3d.com/Manual/GlobalIllumination.html",
        "status": "draft",
        "created_at": "2019-02-22T11:22:18.862-05:00",
        "updated_at": "2019-02-22T11:22:18.862-05:00",
        "ordinal": 2,
        "exercise_votes_threshold": null,
        "exercise_type": 0,
        "free": false,
        "media_type": "text"
    },
    {
        "id": 26,
        "lessonable_type": "Chapter",
        "lessonable_id": 9,
        "title": "Directional Lights",
        "slug": "directional-lights",
        "content": "In this lesson we'll take a look at the most common light you'll encounter whenever you create a scene in Unity. The directional light will act as a sun and is typically used to provide lighting for big, open areas like an outdoor scene. The directional light in Unity 5 is connected to the procedural skybox by default making it easy to create a sunset type of effect. I'll also show you how to add light flares to create a realistic sun flare facing the camera. To learn more about lighting click here: http://docs.unity3d.com/Manual/UsingLights.html",
        "status": "draft",
        "created_at": "2019-02-22T11:23:06.111-05:00",
        "updated_at": "2019-02-22T11:23:06.111-05:00",
        "ordinal": 1,
        "exercise_votes_threshold": null,
        "exercise_type": 0,
        "free": false,
        "media_type": "text"
    }
]

Show Lesson

GET https://yoursite.mavenseed.com/api/v1/lessons/:id

Retrieve a single lesson

Headers

Name
Type
Description

Authorization

string

Auth token

{
    "id": 25,
    "lessonable_type": "Chapter",
    "lessonable_id": 9,
    "title": "Lighting Window",
    "slug": "lighting-window",
    "content": "In this lesson we'll take a look at the lighting window. In this window we can adjust various global illumination settings such as ambient light, lightmaps, and light \"bounce\". This window will become invaluable to adjusting the overall light within your game. To learn more about the lighting window click here: http://docs.unity3d.com/Manual/GlobalIllumination.html",
    "status": "draft",
    "created_at": "2019-02-22T11:22:18.862-05:00",
    "updated_at": "2019-02-22T11:22:18.862-05:00",
    "ordinal": 2,
    "exercise_votes_threshold": null,
    "exercise_type": 0,
    "free": false,
    "media_type": "text"
}
null

Create Lesson

POST https://yoursite.mavenseed.com/api/v1/lessons

Create a lesson. Note: slugs are created automatically from the title, but can updated with the PATCH call below.

Headers

Name
Type
Description

Authorization

string

Auth Token

Request Body

Name
Type
Description

lessonable_id

integer

ID of the type of lesson below

lessonable_type

string

Chapter

title

string

Title of the lesson

content

string

Lesson content

status

integer

0 - draft, 1 - published

ordinal

integer

Order in course

exercise_votes_thresold

integer

NUmber of votes

exercise_type

string

free

string

media_type

string

{
    "id": 25,
    "lessonable_type": "Chapter",
    "lessonable_id": 9,
    "title": "Lighting Window",
    "slug": "lighting-window",
    "content": "In this lesson we'll take a look at the lighting window. In this window we can adjust various global illumination settings such as ambient light, lightmaps, and light \"bounce\". This window will become invaluable to adjusting the overall light within your game. To learn more about the lighting window click here: http://docs.unity3d.com/Manual/GlobalIllumination.html",
    "status": "draft",
    "created_at": "2019-02-22T11:22:18.862-05:00",
    "updated_at": "2019-02-22T11:22:18.862-05:00",
    "ordinal": 2,
    "exercise_votes_threshold": null,
    "exercise_type": 0,
    "free": false,
    "media_type": "text"
}

Update Lesson

PATCH https://yoursite.mavenseed.com/api/v1/lessons/:id

Update a single lesson. All of the above properties in create lesson are valid.

Headers

Name
Type
Description

Authorization

string

Auth token

{
    "id": 25,
    "lessonable_type": "Chapter",
    "lessonable_id": 9,
    "title": "Lighting Window",
    "slug": "lighting-window",
    "content": "In this lesson we'll take a look at the lighting window. In this window we can adjust various global illumination settings such as ambient light, lightmaps, and light \"bounce\". This window will become invaluable to adjusting the overall light within your game. To learn more about the lighting window click here: http://docs.unity3d.com/Manual/GlobalIllumination.html",
    "status": "draft",
    "created_at": "2019-02-22T11:22:18.862-05:00",
    "updated_at": "2019-02-22T11:22:18.862-05:00",
    "ordinal": 2,
    "exercise_votes_threshold": null,
    "exercise_type": 0,
    "free": false,
    "media_type": "text"
}

Delete a Lesson

DELETE https://yoursite.mavenseed.com/api/v1/lessons/:id

Delete a lesson.

Headers

Name
Type
Description

Authorization

string

Auth toke

PreviousEventsNextChapters

Last updated 3 years ago

Was this helpful?