Getting Your API Key

overview momentscience provides a suite of apis for offer delivery, offer management, and performance reporting this guide explains how to get your api key, understand scope permissions, explore available endpoints, manage existing keys, and troubleshoot common issues in this guide, you will learn how to generate an api key from your account assign scopes to control access explore supported api endpoints modify, regenerate, or delete existing keys generate your api key to use momentscience apis, you’ll need an api key tied to your account go to the momentscience dashboard and sign in navigate to your profile settings click generate api key enter a descriptive name (e g , "test key" or "production key") select the appropriate scopes based on the apis you'll use click generate to create the key after creation, securely copy the key and add it to your environment configuration if you need further assistance, you can refer to the quick playable demo for a visual guide on how to generate your api key api scopes scopes define the permissions granted to an api key you can assign multiple scopes to the same key, depending on the needs of your integration select only the scopes required for your use case scope description ads/offers grants access to the momentperks, perkswall, and offer catalog apis use this scope to retrieve and display available offers reports provides access to the reporting api, enabling retrieval of detailed analytics, including impressions, clicks, revenue, click through rates (ctr), and other performance data configurations allows programmatic updates to account level configurations such as themes, branding, and general settings offers management enables the creation, editing, and status control of offers you can update both endemic and third party offers, including setting them to "paused" or "active," or editing creative elements like headlines and descriptions accounts grants permission to create and update sub accounts within your organization perkswallet authorizes access to the perkswallet feature ( save for later) this scope allows the api key to authenticate and manage saved offers, including deletion managing api keys once an api key is created, you can update its name and scopes, regenerate it to invalidate the current value, or delete it if it's no longer needed modify an existing api key go to profile settings click the action menu next to the api key you want to modify select modify api access edit the key’s name or adjust its scopes click update to save changes regenerate an api key regenerating a key disables the old one and generates a new value immediately from the action menu, select regenerate api key a new key will be shown the previous key will no longer be valid copy and store the new key securely delete an api key to permanently delete an api key click the action menu next to the key you want to remove select delete api key click confirm to finalize the deletion deleted api keys cannot be recovered make sure the key is no longer in use before deleting current endpoints the following endpoints are available based on the scopes assigned to your api key api purpose endpoint required scope moments api serve offers during key moments in the user journey (e g after checkout or reward unlock) post /native/v2/offers json ads/offers perkswall api retrieve all perkswall enabled offers for building a branded offer gallery post /native/v4/perkswall json ads/offers offer catalog api get a real time json feed of all active offers, including creatives and tracking metadata get /native/v3/catalog json ads/offers reporting api access detailed performance data including impressions, revenue, clicks, and ecpm get native/activity json reports security best practices storage guidelines api key management // ❌ never expose api keys in client side code const apikey = 'pk live abcd1234 '; // visible to users // ✅ use environment variables for server side code const apikey = process env momentscience api key; // ✅ use secure storage for mobile apps const apikey = await securestore getitemasync('ms api key'); key rotation rotate api keys regularly (recommended every 90 days) implement graceful key transitions in production monitor key usage for anomalies if you have any questions during setup or integration, reach out to us at help\@momentscience com we're here to support you