API

Please share the mem pro API documentation for an external software to read-only retrieve the subscription plans of a user by passing the membership number(which is a custom field).

Hello

Unfortunately, we don't have an API like that. So you will need to implement the API yourself

Try to look at API controller components/com_osmembership/controller/api.php to see how we implemented some basic API and implement the API you need yourself:

To use APIs, you need to:

1. Go to Membership Pro -> Configuration, set Enable API config option to Yes. Enter the API Key into API Key config option. You need to pass that key in every API request

2. The request will be made to this URL (depends on the API you want to call)

domain.com/index.php?option=com_osmembership&task=api.get&id= [SUBSCRIPTION_ID]&api_key=[API_KEY]

domain.com/ needs to be replaced with your site domain
[SUBSCRIPTION_ID] is ID of the subscription record to get data (the data you pass here depends on the API method you call)

[API_KEY] is the API Key you entered in Configuration. It's used to validate every API request before perform the required action

Hope it gives you some clues

Tuan

Hi Tuan,

thanks, this is helpful.
1) I tried the below but data shows even without the API key?
2) how do i get the variable names etc of the mempro to use to build a API function, is there any documentation.

Hello

1. Look like you are not using latest version of Membership Pro ? The API code was only supported recently

2. We don't have documentation for it. This is something you will have to build it yourself depends on what you want the API to do/return data for you. You need to know Joomla programming, understand Membership Pro data structure to implement your custom API. As mentioned, you can look at components/com_osmembership/controller/api.php to see some basic API methods which I implemented for the extension and implement custom api for your need

Tuan

I am using the latest version, please check on my test site -

login details sent via support ticket

tried-

OK. I will check it and reply you with the result via support ticket

Regards,

Tuan