Standalone customer portal
Learn how link the Bunny customer portal with your platform to enable self service subscription management and upgrades.
This guide covers the customer portal integration from a developers point of view. It assumes that you have already setup your Products in Bunny and enabled them to be visible for self service.
TLDR… This integration involves using the API to generate a token that will be appended to a customer portal url that you will redirect the user over to for subscription management.
Setup API credentialsLink to Setup API credentials section
Make a request from your backend to obtain the portal security token using the portalSessionCreate graphql request.
The API client will need the portal:write scope. security:write also works, but it lets the client manage your users and roles as well, so prefer portal:write.
Use the API client to generate a new access token with the portal:write scope.
Request a portal tokenLink to Request a portal token section
The portal token is obtained using the portalSessionCreate graphql request.
Attributes
{
"tenantCode": "superdesk-123",
"expiry": 123 // optional - default 24 hours
}
Mutation
mutation portalSessionCreate ($tenantCode: String!, $expiry: Int) {
portalSessionCreate (tenantCode: $tenantCode, expiry: $expiry) {
errors
token
}
}
res = await bunny.portalSessionCreate("superdesk-123");
res = BunnyApp::PortalSession.create(
tenant_code: 'superdesk-123'
)
On success the response will contain a token attribute. You need to extract this token and use it in the next step.
{
"data": {
"portalSessionCreate": {
"errors": null,
"token": "eyJhbGciOiJIUzUxMiJ9.eyJleHAiOjE2ODE4MzY4NDUsImlzcyI6Imh0dHBzOi8vYnVubnkuYnVubnkuY29tIiwiYXVkIjoicG9ydGFsIiwiaWF0IjoxNjgxNzUwNDQ1LCJzdWJkb21haW4iOiJidW5ueSIsInVpZCI6NDA1LCJ1aWRfdHlwZSI6IlRlbmFudCIsInJlYWNoX2lkIjo1NDAsInJlYWNoX3R5cGUiOiJBY2NvdW50Iiwic2NvcGUiOiJwcm9kdWN0OnJlYWQgYmlsbGluZzpyZWFkIHN0YW5kYXJkOndyaXRlIHN0YW5kYXJkOnJlYWQiLCJvYmplY3RfaWQiOjQwNSwib2JqZWN0X3R5cGUiOiJUZW5hbnQifQ.78epnLpeJBs2UX1SrjxYdkKkEL_x4iy_AlAo6LuxQQkA7O5jvgEA00X3Zh9Z-MdLoBhGtSrK3Kv-Gb2lOAb3tQ"
}
}
}
Redirect to the customer portalLink to Redirect to the customer portal section
The final step is to redirect the browser to the customer portal by appending the token to the base url for your customer portal.
https://{{subdomain}}.bunny.com/portal?token={{token}}
You can also redirect to specific pages within the customer portal by including the path to that page.
// subscriptions
https://{{subdomain}}.bunny.com/portal/subscriptions?token={{token}}
// transactions
https://{{subdomain}}.bunny.com/portal/transactions?token={{token}}
// payment methods
https://{{subdomain}}.bunny.com/portal/payment-method?token={{token}}