Manage your own subscriptions
Be in control of detecting users, performing PIN validation, managing billing, and compliance messaging for all your subscribers via the Infomedia API.
The sequence diagram shows the steps and API methods required in order to validate a new customer for a subscription. The diagram depicts only the successful flow; error messages for each API method should be handled as documented in the individual method pages.
Breakdown of steps:
1-3. Give the user the ability to provide their mobile number on the Partner platform and initiate a subscription.
4-6. Partner calls the
PinGenerateWithParamsAPI method to send a PIN SMS to the user via the Infomedia platform.
7. Partner displays a PIN entry page to the customer.
8. User inputs the PIN on the Partner's platform and clicks to confirm the subscription.
a. For products that have a free period, Partner calls PinValidateWithParams to validate the user has entered the correct PIN, then handles the response.
b. For products that do not have a free period, Partner calls SendBillWithPin to both validate the user has entered the correct PIN and perform the first charge operation.
11. Partner subscribes the user in their platform
12-13. Partner calls the LogActivity API method to notify Infomedia that a successful subscription has occurred. API response provided to Partner containing status.
14-16. Partner calls SendMessageWithCampaign to send a Welcome SMS to the customer.
17. Partner redirects the customer to the service.
Charging a customer at renewal time:
Once it is time to renew the customer's subscription, Partner calls SendBill to perform a charge.
Following a successful charge, depending on the carrier, Partner may be required to call SendMessageWithCampaign to send a Bill Confirmation SMS to the customer. Alternatively these messages can be configured and automated at Infomedia's side.
Send reminder SMS:
Depending on the carrier, Partner may be required to regularly call SendMessageWithCampaign to send a Reminder SMS to the customer.
Cancelling customer's subscription:
Once you cancel your customer's subscription in your platform, Partner calls SendMessageWithCampaign to send an Unsubscribe SMS to the customer.
Call the LogActivity API method to notify Infomedia so that both platforms are in sync.
Get Production access:
Once you're happy with your Sandbox tests and you want Production access, sign in and go to Products and click on Production. Configure a 'subscription' just as you did for Sandbox. Give your subscription a relevant name, again you can change this later if required.
Your Production subscription will be sent to Infomedia for approval. Once approved, you will have access to the production API. Click on the green 'Try It' button to test your request and see a response from any of the required production API methods.
Note: Your API access key will only be pre-populated after your Production subscription request has been approved by Infomedia.
If you require any assistance, contact us on email@example.com