This reference explains where the Sponsorship Console and Sponsorship API are published, how Console links behave, and where to find the API description when you are planning an integration.
| Item | Behavior |
|---|---|
| Sponsorship Console | The Console has its own dedicated address and uses an encrypted connection. After it loads, sign-in and permission checks happen in the Console. |
| Sponsorship API | Every Sponsorship service is available from one stable, public address. |
| API description | The API description is published at a public address, so you can review it without signing in while you plan an integration. |
| Encryption | Every API request must use an encrypted HTTPS connection with a current version of TLS. |
| Response caching | Sponsorship API responses do not come from a shared cache, so one caller never receives a response meant for another. |
| Deep links | A saved or shared link to a specific Console page opens that page directly, not just the Console home page. |
How to Read It
- One address for the whole API. You use the same Sponsorship API address for every kind of Sponsorship record. Opportunities, applications, sponsorships, and settings are available at different paths under that address.
- Encrypted only. The API refuses requests that are not encrypted or that use an outdated TLS version. If your integration cannot connect, confirm that it uses HTTPS and a current TLS version.
- No cached answers. The API never serves responses from a shared cache, so you receive a current answer for your own account. The API does the work again for each request instead of reusing another caller’s response.
- The API's description can lag a fresh publish. After Rhythm publishes an updated API description, it can take up to fifteen minutes to appear at its address. If you fetch the description right after an update and it looks unchanged, wait a few minutes and try again.
- Console links are safe to bookmark and share. The Console opens links to specific pages directly, so you can bookmark a particular opportunity, application, or sponsorship, or share that link with a colleague. The link opens that page instead of sending the recipient to the Console home page.
Applicability
Use this reference if you administer or build an integration with the Sponsorship API, troubleshoot a connection to it, or confirm that a bookmarked or shared Console link opens as expected.