Custom Setup and Usage

Custom API Queries

GetUserInfo performs a simple query to fetch basic information about a user which should cover most use cases, e.g. just checking if a user has subscribed to your campaign or is subscribed to a specific tier.

If you need more information or just want to build and run your own queries against the SubscribeStar API, though, QuerySubscribeStarAPI provides an easy way to do this.

For example, to query for a subscriber's name using the query string {subscriber { name }}:

The Result will be the JSON string returned by the API. JSON parsing tools are not provided as part of this plugin as there are a wide variety of existing solutions, free, paid, and built-in.

See the SubscribeStar API Documentation for more information about how to construct queries.

Authentication through your own web service

If you have your own web service to handle authentication with SubscribeStar's API, or you want to implement one to keep your client_secret outside of the application binary, then there is a helper to construct a login URL for you which will redirect users to your web service after authenticating:

Open URL will open the URL in the user's default web browser.

Using tokens relayed from your own web service

If you already have an existing SubscribeStar integration and/or your own account system, you may wish to fetch access tokens for users from your service rather than going through the in-app authentication process described in SimpleSetup.

Given that you have some endpoint (e.g. /get-user-token) which can return a valid token for a known user, you can fetch, parse, and use it as follows:

For any questions, help, suggestions or feature requests, please feel free to contact me at nbpsup@gmail.com