The IActionable REST Web Service API allows for custom integration of our reward and reputation services within your application. The following documentation describes the various actions and features that are available.
API Routes
All of our API calls are made by calling the base URI and appending the appropriate route:
| Route | Get | Post |
|---|---|---|
| partner/{partnerId} | - | - |
| partner/{partnerId}/achievements | Get a list of achievements offered by this partner | - |
| partner/{partnerId}/achievements/{achievementId} | Get the details of a particular achievement | - |
| partner/{partnerId}/profiles | Get a list of entity Id types | - |
| partner/{partnerId}/profiles/{profileType} | Get a list of all profiles with this entity Id | - |
| partner/{partnerId}/profiles/{profileType}/{profileId} | Get a summary of this profile | Manually create a profile |
| partner/{partnerId}/profiles/{profileType}/{profileId}/points | Get a summary of the profile’s points | Adjust a profile’s current and total points |
| partner/{partnerId}/profiles/{profileType}/{profileId}/points/transactions | Get a historical list of transactions for a profile | - |
| partner/{partnerId}/profiles/{profileType}/{profileId}/points/transactions/{transactionId} | Get details about a point transaction | Create a transaction – this “spends” the profile’s current points (not total points). |
| partner/{partnerId}/profiles/{profileType}/{profileId}/notifications | Get the latest notifications for the profile | - |
| partner/{partnerId}/profiles/{profileType}/{profileId}/events | - | - |
| partner/{partnerId}/profiles/{profileType}/{profileId}/events/{eventKey} | - | Post an event for this profile. |
| partner/{partnerId}/profiles/{profileType}/{profileId}/achievements | List all awarded and unawarded achievements for this profile. | - |
| partner/{partnerId}/profiles/{profileType}/{profileId}/achievements/{achievementId} | Get the details of a particular achievement for a profile, including progress. | Award achievement to this profile. |
| partner/{partnerId}/profiles/{profileType}/{profileId}/achievements/awarded | List all awarded achievements for this profile. | - |
| partner/{partnerId}/profiles/{profileType}/{profileId}/achievements/unawarded | List all unawarded achievements for this profile. | - |
