Our Impact developer platform
Sandbox APIShip the widget. Identify supporters. Check entitlements.
A complete integration path for adding a community campaign to an existing product without replacing its authentication, payments, or customer database.
Integration path
Start with the smallest useful integration. Each phase works independently and builds on the previous one.
Embed the campaign
Mount a published campaign with its public ID. No developer project or customer identity is required yet.
Widget guideIdentify supporters
Use your project secret on the server to mint a short-lived token for the customer your app already authenticated.
Identity guideCheck entitlements
Use the publishable key and identity token in the browser, or the secret SDK for authoritative server checks.
Entitlement guideBefore you write code
The SDKs consume configuration created in the dashboard. Complete these checks once for each environment.
Publish a campaign
Copy the public ID from its embed URL.
Create a developer project
Copy the publishable key and one-time secret key.
Add allowed browser origins
Include the exact protocol, host, and port used by your app.
Create an entitlement rule
Choose a stable key your product can depend on.
The final product check
Program owners can evolve the earning rule while your application continues to depend on one stable entitlement key.
const impact = new OurImpact({
publishableKey: process.env.NEXT_PUBLIC_OUR_IMPACT_PUBLISHABLE_KEY!,
userToken,
});
if (await impact.user.is("community_champion")) {
enableCommunityChampionExperience();
}Follow a real integration
The Michael Scott Paper Company repository records the integration as three reviewable Git branches, from an untouched storefront to an identified entitlement experience.
Before integration
A working paper storefront with its own accounts, catalog, cart, and checkout. No Our Impact code.
View branch phase oneCampaign widget
Adds @our-impact/browser and mounts a public campaign without changing the storefront’s identity system.
View branch phase twoIdentity and entitlement
Adds the server SDK, short-lived identity, identified widget, entitlement check, and a product-specific reward.
View branch