Git Product home page Git Product logo

platform-documentation's Introduction

Patreon Platform Documentation

This is the public resource that powers docs.patreon.com. If you would like to contribute, just make a pull request!

To run locally: bundle install bundle exec middleman server

Operations

Changes to this repo are automatically deployed some time after merging code.

Powered by slate

The Patreon API docs use slate and more documentation on the docs system can be found there.

platform-documentation's People

Contributors

21echoes avatar blackxored avatar bootstraponline avatar chrissrogers avatar codebard avatar csantillana avatar cvkef avatar derekr avatar djpowers avatar dlackty avatar emosespatreon avatar hellojustin avatar iandelahorne avatar jlee318 avatar joemckenney avatar jrsun avatar kevin-buttercoin avatar liranuna avatar lord avatar maks3w avatar marcguyer avatar phildini avatar pomier avatar ray-patreon avatar realityking avatar rezanachmad avatar rlord avatar spencerhandley avatar talsraviv avatar victorquinn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

platform-documentation's Issues

API docs use terms that are undefined and unclear.

Question:
I am looking to get a full list of people giving money to a Patreon account owner from the API, preferable with one of the official libraries. The docs talk about "user", "campaign" and "pledge" as well as "patron" and "creator". The python API (to choose the first one I looked at) has functions to fetch "user", "campaign", "campaign and patrons" and "page of pledges".

It seems like the "creator" is the Patreon account owner and the "patron" are people who are currently subscribed to that creator. But then what is a "user"? What exactly is a campaign? Why do I need one? Why are patrons assigned to campaigns and not creators? Do I need to iterate over campaigns and then for each campaign look at all the patrons? What is a pledge? Is that a single transaction or a synonym for a person somehow?

Can you please define these terms or point me at the doc I missed?

  • Creator:
  • Patron:
  • Campaign:
  • User:
  • Pledge:

Thanks!

Empty results for identity resource (API v2)

Hello.
For starters, I'm not sure if the problem is with me or not, to be quite frank. If this is somehow my fault, I'm sorry.

I have a creator account in Patreon and recently I made another, personal one, in order to test the Patreon API for my application. After properly dealing with the OAuth (requesting the identity scope), I made an identity GET request to https://www.patreon.com/api/oauth2/v2/identity. I keep getting the same results:

{
  "data": {
    "attributes": {},
    "id": (numerical value),
    "relationships": {
       "memberships": { data: [] },
      "type": "user"
    },
    ... (I also received the links field, but I'm omitting it here)
  }
}

What bothers me is just that the attributes field is empty (I have not made any pledge yet, so my relationship data being empty is more than expected. I have checked my own account to check if there are any privacy settings, but didn't find anything either.

any help would be greatly appreciated, and thanks again!

Question: Missing pledge event types on campaign member APIv2 request

Hi There,

I'm observing an issue with making a request to the campaign members api v2 endpoint. The request has an include for pledge_history (a relationship of member) which is described to return an array of Pledge Events. I've observed that the API is failing to return pledge events of the type pledge_downgrade and pledge_upgrade. I believe this is potentially a bug as other pledge event types are returned as expected.

I'm making this api call for campaign 2416453 using ruby (2.7.0) via the httparty library.

Happy to provided additional debugging information if needed.

Thanks!

Feature: Create new posts

Are there any plans to include post creation via API?

It would be great to automate this process for release notes, when a new version of a software is released for example.

(not sure this is the correct place to suggest API features, but where else would i do this?)

Feature: Resources should describe results better

https://docs.patreon.com/#resources just has a list of what will be returned, but doesn't say what they all mean.

For example, the different between pledge.pledge_cap_cents and pledge.amount_cents.

I've been having a hard time figure out how to do basic things with your API.

It could also use some example for common things, ie get users current pledge of your campaign.

Also figuring out what API version to use or which one the docs are talking about is confusing, you separate them into two completely different docs, and not act like everyone already knows how to use apiv1.

Feature: document required / recommended User-Agent

In the #dev-and-api channel on Discord, the latest pinned message states that (while reverted for a while) a 'User-Agent' header should be provided.

Api docs will be updated today

As far as I know, the api docs have not been updated to reflect this change.

Question: `image_url` and `image_small_url` return the same value

Looking specifically at the Campaign v2 attributes here: https://docs.patreon.com/#campaign-v2

The documentation suggests that the values should be as follows:

  • image_url: Banner image URL for the campaign
  • image_small_url: URL for the campaign's profile image

However, when calling the endpoints that have this resource, it always gives me the same value, which is the banner image. I've tried the following endpoints

  • https://www.patreon.com/api/oauth2/v2/campaigns
  • https://www.patreon.com/api/oauth2/v2/campaigns/{campaignId}

The campaign I'm getting these results for has the ID of 11652576.

For clarity, I'm calling both of these using the following encoded params and via fetch node

const params = new URLSearchParams({
   'fields[campaign]': 'url,vanity,patron_count,image_small_url,image_url',
});

const response = await fetch(`${url}?${params.toString()}`, {
   headers: { Authorization: `Bearer ${token}` },
});

I wasn't entirely sure if this was the right place for a bug report as I'm not using the patreon-js package, just the API directly - apologies in advance. Any help is greatly appreciated ❤️

Feature: Add documentation for PATCH-ing Members

There's no documentation on how to update members, for example adding a Creator Note (member.note) programmatically. I had to discover the method using Browser Dev Tools from my Creator Dashboard.

Come on guys, you run the most popular membership platform in the world. This sort of friction is what causes new creators interested in tight app integration, like myself, to skip Patreon entirely.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.