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
  • API Login
  • API Login
  • API Requests

Was this helpful?

Export as PDF
  1. Developers

API

Mavenseed has a RESTful API that is available to account owners. It can be accessed at https://yoursite.mavenseed.com/api/v1

Authentication is handled via a secure token, which is used to make requests after logging into the API with your account email and password.

API Login

Send a POST request to https://yoursite.mavenseed.com/api/login with the email and password that you used to create your account with. In the return response, you will receive an authentication token that you can use to make future requests with.

API Login

POST https://yoursite.mavenseed.com.com/api/login

Query Parameters

Name
Type
Description

email

string

Account email

password

string

Account password

{'auth_token': 'XXXXXX'}

API Requests

Further requests to the API require the auth token that was returned to you after logging in through the API. Here's an example request that includes the auth token to grab all events. The auth token is sent in the headers of the request.

curl --header "Authorization: Bearer TOKEN-FROM-LOGIN" https://yoursite.mavenseed.com/api/v1/events

The rest of this documentation assumes that the auth token will be present in the requests to the API.

Just a heads up, the documentation tool here makes it a bit hard to understand the format of the requests to the api. The case is the same for all API resources, but for example let's consider a "customer". Here's a screenshot that shows that the properties that you're trying to either create, update, or destroy, requires to be nested within the resource name. This should be in JSON in your request to the API.

Example: { "customer": { "email": "apiupdate@sdsdsd.com"}}

Here's an example using Ruby to update a customers email.

require 'uri'
require 'net/http'

url = URI("https://yoursite.mavenseed.com/api/v1/customers/55")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Bearer AUTHTOKENFROMLOGIN'
request["cache-control"] = 'no-cache'
request["Postman-Token"] = 'eb9d400b-9e60-4f2e-a72a-289adbf66f34'
request.body = "{ \"customer\": { \"email\": \"updatetheemail@someusersemail.com\"}}"

response = http.request(request)
puts response.read_body

If you have any questions on any of this, just email me nick@mavenseed.com

PreviousSEONextCoupons

Last updated 5 years ago

Was this helpful?