Download the PHP package remp/crm-subscriptions-module without Composer
On this page you can find all versions of the php package remp/crm-subscriptions-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download remp/crm-subscriptions-module
More information about remp/crm-subscriptions-module
Files in remp/crm-subscriptions-module
Package crm-subscriptions-module
Short Description CRM Subscriptions Module
License MIT
Homepage https://remp2030.com
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package crm-subscriptions-module
CRM Subscriptions Module
This documentation describes API handlers provided by this module for others to use. It expects your application is based on the CRM skeleton provided by us.
Installing module
We recommend using Composer for installation and update management.
Enabling module
Add installed extension to your app/config/config.neon file.
Widgets
Widgets are small reusable components that can be used on different places within CRM. Module can provide widget placeholders for other modules to populate or widget implementations.
Available widgets
SubscribersWithMissingAddressWidget
Widget displays list of all subscribers with specified content access that don't have specified address type entered in the system. It is placed at the admin.payments.top placeholder, above the payments listing.
By default the widget displays all print subscribers without print address type entered. You can change the configuration in your config.local.neon and check different content access names against different address types:
Available placeholders
These are widget placeholders provided by Payments Module. You can register your own widgets to be displayed at following places:
admin.payments.toppayments.banktransfer.rightpayments.admin.payment_source_listingpayments.admin.payment_item_listingpayments.frontend.payments_my.toppayments.arpu.bottom
API documentation
All examples use http://crm.press as a base domain. Please change the host to the one you use
before executing the examples.
All examples use XXX as a default value for authorization token, please replace it with the
real tokens:
- API tokens. Standard API keys for server-server communication. It identifies the calling application as a whole.
They can be generated in CRM Admin (
/api/api-tokens-admin/) and each API key has to be whitelisted to access specific API endpoints. By default the API key has access to no endpoint. - User tokens. Generated for each user during the login process, token identify single user when communicating between
different parts of the system. The token can be read:
- From
n_tokencookie if the user was logged in via CRM. - From the response of
/api/v1/users/loginendpoint - you're free to store the response into your own cookie/local storage/session.
- From
API responses can contain following HTTP codes:
| Value | Description |
|---|---|
| 200 OK | Successful response, default value |
| 400 Bad Request | Invalid request (missing required parameters) |
| 403 Forbidden | The authorization failed (provided token was not valid) |
| 404 Not found | Referenced resource wasn't found |
If possible, the response includes application/json encoded payload with message explaining
the error further.
GET /api/v1/users/subscriptions
Returns all user subscriptions with information when they start/end and which content type they give an access to.
Headers:
| Name | Value | Required | Description |
|---|---|---|---|
| Authorization | Bearer String | yes | User token. |
Params:
| Name | Value | Required | Description |
|---|---|---|---|
| show_finished | Boolean | no | Flag indicating whether to include finished subscriptions or not. If not provided, only active and future subscriptions are returned. |
Example:
Response:
POST /api/v1/subscriptions/create
Creates new subscription for given user and returns new instance.
Headers:
| Name | Value | Required | Description |
|---|---|---|---|
| Authorization | Bearer String | yes | Bearer token. |
Params:
| Name | Value | Required | Description |
|---|---|---|---|
| String | yes | Email of existing user. | |
| subscription_type_id | String | no | ID of subscription type to use. List of all subscription types is available at /subscriptions/subscription-types-admin. Either subscription_type_id or subscription_type_code must be filled. |
| subscription_type_code | String | no | Code of subscription type to use. List of all subscription types is available at /subscriptions/subscription-types-admin. Either subscription_type_id or subscription_type_code must be filled. |
| is_paid | Boolean | yes | The identification of paid subscriptions. |
| start_time | String | no | RFC3339 formatted start time. If not present, subscription will start immediately. |
| end_time | String | no | RFC3339 formatted end time. If not present, end time will set based on subscription type. |
| type | String | yes | Type of subscription - values allowed: regular, free, donation, gift, special, upgrade, prepaid. If not provided, defaults to regular. |
Example:
Response:
POST /api/v1/subscriptions/update
Update subscription based on sent parameters.
Headers:
| Name | Value | Required | Description |
|---|---|---|---|
| Authorization | Bearer String | yes | Bearer token. |
Params:
| Name | Value | Required | Description |
|---|---|---|---|
| id | String | yes | Email of existing user. |
| subscription_type_id | String | no | ID of subscription type to use. List of all subscription types is available at /subscriptions/subscription-types-admin. |
| is_paid | Boolean | no | The identification of paid subscriptions. |
| start_time | String | no | RFC3339 formatted start time. If not present, subscription will start immediately. |
| end_time | String | no | RFC3339 formatted end time. If not present, end time will set based on subscription type. |
| type | String | no | Type of subscription - values allowed: regular, free, donation, gift, special, upgrade, prepaid. If not provided, defaults to regular. |
Example:
Response:
Components
ActualSubscribersRegistrationSourceStatsWidget
Admin dashboard stats graph widget.
ActualSubscribersStatWidget
Admin dashboard stats widget.
ActualSubscriptionLabel
Admin user listing component.
ActualSubscriptionsStatWidget
Admin dashboard actual subscriptions count widget.
ActualUserSubscriptions
Admin user detail stats widget.
EndingSubscriptionsWidget
Admin ending subscriptions listing widget.
MonthSubscriptionsSmallBarGraphWidget
Admin users header graph widget.
MonthSubscriptionStatWidget
Admin dashboard single stat widget.
MonthToDateSubscriptionStatWidget
Admin dashboard single stat widget.
PrintSubscribersWithoutPrintAddressWidget
Admin payments listing header widget.
RenewedSubscriptionsEndingWithinPeriodWidget
Admin dashboard stats widget.
SubscriptionButton
Admin listing edit subscription button widget.
SubscriptionEndsStats
Admin ending subscriptions types and content access listing component.
SubscriptionsEndingWithinPeriodWidget
Admin dashboard ending subscriptions stats widget.
TodaySubscriptionsStatWidget
Admin dashboard single stat widget.
TotalSubscriptionsStatWidget
Admin dashboard single stat widget.
UserSubscriptions
Admin user detail subscriptions listing widget.
