Members API

Use the documentation below to learn how to build on top of the ProductDyno Members API.

Members API

How To Get Your API Key #

ProductDyno’s licensing system is a service which creates and manages licenses of single Products (not available for Collections) for customers who activate the service.

The service is activated by switching on the "Enable Licenses" switch under the Licensing section of a Product. A customer may also limit the number of licenses which will be issued to each verified buyer of the product.

The issued licenses are given to the buyer on a specific Licenses page they may view when they login to download their product. They are also available via API (see below).

Get Member Details Using Credentials #

This method will return a member's details using the member's email and password.

Once an API key, email, password, product ID or channel ID are sent, the response will show the status of a member. [status: 1 = active] - if response does not include 'status' or if 'status' is not equal to '1', then credentials are wrong or user does not have access.

PATH
https://app.productdyno.com/api/v1/members/get-by-credentials
METHOD
GET
PARAMETERS
_api_key
email
password
product_id OR channel_id
EXAMPLE JSON RESPONSE
{
  "member_id": 73,
  "first_name": “John”,
  "last_name": “Doe”,
  "email": “john.doe@productdyno.com",
  "payment_gateway_ids": [123, 456],
  "status": 1
}

Get Member Details Using Access Token Or Member ID #

This method will return a member's details using an access token or member ID.

Once an API key and member ID or access token are sent, the response will show the status of a member. [status: 1 = active] - if response does not include 'status' or if 'status' is not equal to '1', then credentials are wrong or user does not have access.

Using an access token is optional; you may use it in order to utilise one-click-login from inside your ProductDyno members' area. An access token can be generated automatically by using the shortcode {access_token}.

PATH
https://app.productdyno.com/api/v1/members/get
METHOD
GET
PARAMETERS
_api_key
member_id OR access_token
EXAMPLE JSON RESPONSE
{
  "member_id": 73,
  "first_name": “John”,
  "last_name": “Doe”,
  "email": “john.doe@productdyno.com",
  "payment_gateway_ids": [123, 456],
  "status": 1
}

Add Member Using API #

This method will add a member to a Product or Collection via API and using an API Key.

You may find the product_id or collection_id at the end of the URL when managing your product or collection

Payment gateway IDs are only needed for Collections. Since payment gateways with Products only have a one-to-one ratio, all that is needed is the Product ID. With Collections, payment gateways have a many to one ratio, and so we'll need to know which payment gateway id the member will be added to. You may find a payment_gateway_id on the Payment Gateways screen for a collection.

Once the correct parameters are sent, the response will include the status of a member. [status: 1 = active] - if response does not include 'status' or if 'status' is not equal to '1', then credentials are wrong or request could not be processed.

PATH
https://app.productdyno.com/api/v1/members/add
METHOD
POST
PARAMETERS
      _api_key
      first_name
      last_name
      email
      product_id OR collection_id
      payment_gateway_ids[] (Array) - required for collection only
      expired_at[] (Array) - optional for collections
EXAMPLE JSON RESPONSE
{
      "member_id": 523,
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@productdyno.com",
      "status": 1,
      "collection_id": "7"
      "product_id": "58"
}

Update Member Using API #

This method will update a member's details for a Product or Collection they are attached to via API and using an API Key.

You may find the product_id or collection_id at the end of the URL when managing your product or collection

Payment gateway IDs are only needed for Collections. Since payment gateways with Products only have a one-to-one ratio, all that is needed is the Product ID. With Collections, payment gateways have a many to one ratio, and so we'll need to know which payment gateway id the member will be added to. You may find a payment_gateway_id on the Payment Gateways screen for a collection.

IMPORTANT NOTE: Before updating a member of a collection, be sure to use the "Get Member" method to get all of the payment_gateway_ids that the member has access to. In addition, it is important to send ALL payment_gateway_ids that the member will have access to after the update. If you do not send a payment_gateway_ids value with the "Update Member" method, the member will not have access to that collection variation.

Once the correct parameters are sent, the response will include the status of a member. [status: 1 = updated] - if response does not include 'status' or if 'status' is not equal to '1', then credentials are wrong or request could not be processed.

PATH
https://app.productdyno.com/api/v1/members/update
METHOD
POST
PARAMETERS
      _api_key
      first_name
      last_name
      email
      product_id OR collection_id
      payment_gateway_ids[] (Array) - required for collections only - list all that user will have access to
      expired_at[] (Array) - optional for collections
EXAMPLE JSON RESPONSE
{
      "member_id": 523,
      "first_name": "John",
      "last_name": "Doe",
      "email": "john.doe@productdyno.com",
      "status": 1,
      "collection_id": "7"
      "product_id": "58"
}

Delete Member Using API #

This method will delete a member via API and using an API Key.

Once the correct parameters are sent, the response will include a boolean value for 'success'...if true, then member has been deleted. This method will also return a message.

Remember that a member may have several IDs associated with them...each member has a separate ID for each Product or Collection they have access to. So, deleting a member ID means you are only deleting that member ID from whichever Product or Collection that ID has access to...not the member completely from your entire account.

PATH
https://app.productdyno.com/api/v1/members/delete
METHOD
GET
PARAMETERS
      _api_key
      member_id
EXAMPLE JSON RESPONSE
{
      "success": true,
      "message": "Member deleted successfully"
}

Update Member Password Using API #

This method is the second half of resetting a user's password. In the "Forgot Password" method above, you should have received a reset code from the URL you configured in the "Reset Password" email you configured in the Customize-Emails screen of your product or collection inside of your ProductDyno dashboard.

Once you have the reset code and the user's new password (whether you allow the user to create their own password or you create one for them), you may post this request to update the ProductDyno system.

PATH
https://app.productdyno.com/api/v1/members/reset-password
METHOD
POST
PARAMETERS
     _api_key
     code
     password
     product_id OR collection_id
EXAMPLE JSON RESPONSE
{
      "success": true,
      "message": "Password updated successfully."
}
Suggest Edit