Authenticate Rankr with the SaaS API using OAuth 2.0. Request the oauth.readonly scope to view installed locations and verify permissions before enabling data access.
Rankr uses OAuth 2.0 tokens to securely connect to the SaaS API. Store tokens securely and rotate keys regularly to maintain access.
Key endpoints include: GET /oauth/installedLocations to list installed locations; POST /oauth/locationToken to exchange authorization codes for tokens; saas/location.write to configure a location; PUT /update-saas-subscription/:locationId to update a subscription; POST /enable-saas/:locationId to enable a SaaS connection.
Trigger: When a user authorizes Rankr via OAuth, the SaaS API creates an installedLocation entry.
Actions: Retrieve installedLocations, generate a locationToken, and store tokens for future requests.
GET /oauth/installedLocations
Key Fields: locationId, clientId, accessToken, refreshToken, scope
Trigger: After initial install, refresh tokens periodically to maintain access without user intervention.
Actions: POST /oauth/locationToken to renew tokens and update stored credentials.
POST /oauth/locationToken
Key Fields: locationId, accessToken, refreshToken, expiresIn, tokenType
Trigger: When a SaaS subscription changes or a location is updated, reflect changes in Rankr via saas/location.write.
Actions: PUT /update-saas-subscription/:locationId and POST /enable-saas/:locationId to apply changes.
PUT /update-saas-subscription/:locationId
Key Fields: locationId, subscriptionId, status, planId
Benefit 1: Jump-start integration with secure OAuth flows—no custom backend required.
Benefit 2: Real-time data sync for installed locations and subscriptions, improving accuracy and timeliness.
Benefit 3: Scalable connections across multiple charity sites with centralized control and monitoring.
This glossary defines endpoints, OAuth scopes, locations, tokens, and how they relate in the Rankr–SaaS API integration.
OAuth 2.0 is the authorization framework used to grant Rankr access to the SaaS API without sharing user credentials.
A connected site or instance where Rankr is installed and linked to the SaaS API.
A specific SaaS location that has been installed and authorized within the Rankr integration.
A URL path exposed by the SaaS API used to access or modify data.
Automatically provision new charity sites in Rankr when a new SaaS location is installed, preconfiguring essential settings and access.
Use periodic checks and webhooks to verify site health, triggering alerts and self-healing workflows when issues arise.
Seamlessly migrate between plans and update subscriptions without downtime by syncing changes through the SaaS API endpoints.
Register your Rankr app with the SaaS API and request the oauth.readonly scope to read installed locations.
Complete the OAuth flow to authorize Rankr to access installed locations and tokens, then save credentials securely.
Test the endpoints, verify token refresh, and enable live data sync for charity sites. Monitor for errors and security alerts.
The installedLocations endpoint returns all SaaS locations that Rankr is connected to. It lets you view locationId, status, and basic metadata to guide setup. This is the first step to establish a stable integration. It also helps you verify permissions before performing writes. Two paragraphs explain how to interpret the data and how to proceed with token creation.
Yes. This integration is designed to minimize coding. Start with OAuth setup and endpoint usage, then leverage the provided data structures for installs, tokens, and subscriptions. If you do need code, you can extend Rankr with webhooks or scheduled tasks to manage longer-running workflows.
Tokens are renewed using the locationToken endpoint. Access tokens have a defined expiry and should be refreshed with a refresh token when provided. Regularly rotating credentials improves security and keeps your connection healthy without user intervention.
The integration supports standard SaaS API subscriptions and location updates. You can manage multiple locations from a single Rankr instance and apply subscription changes across all connected charity sites. Review plan compatibility in your SaaS API documentation.
A sandbox environment is available for testing integrations. Use the sandbox to validate OAuth flows, endpoint responses, and token handling before going live. Always verify data integrity and access scopes in the test environment.
If a connection fails, check token validity, scopes, and endpoint responses. Re-authenticate if necessary, refresh tokens, and verify that the locationIds match between Rankr and the SaaS API. Review the endpoint logs for detailed error messages.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
