APIs Documentation
MomentScience offers a variety of APIs that allow seamless integration of offers, active offer retrieval, and performance reporting for your account. This documentation covers key steps for obtaining your API key, the available API scopes, endpoints, and additional resources for integration.
To get your API key for MomentScience, follow these steps:
- Generate API Key: Click on the "Generate API Key" button.
- Enter API Key Name: Enter a name for your API key to help identify it later (e.g., "Test API Key" or "Production API Key").
- Set Scopes: Select the appropriate access scopes based on the API functionality you intend to use.
- Complete Process: Click the "Generate" button to complete the process and generate your key.
Your API key will be ready to use once generated.
If you need further assistance, you can refer to the quick playable demo for a visual guide on how to generate your API Key.
The following scopes define the permissions granted to the API key. Each scope corresponds to a specific set of actions that can be performed:
- Ads/Offers: Grants access to the MomentPerks, Perkswall, and Offer Catalog APIs, enabling interaction with offers.
- Reports: Provides access to the Reporting APIs, allowing you to retrieve detailed analytics and reports.
- Configuration: Permits programmatic updates to account settings, theme configurations, and other related properties
- Offers Management: Allows the creation and modification of offers, including the ability to set third-party offers to "Paused" or "Active" status. For endemic offers, you can edit details like headlines and descriptions.
- Accounts: Grants the ability to programmatically create and update sub-accounts within your organization.
- PerksWallet: Authorizes the API key to authenticate and request operations related to Saved Offers, including deletion.
The Moments API offers flexibility in serving Offers at critical moments during your users' interactions with your app or website.
The Perkswall API empowers publishers to seamlessly integrate a perks gallery within their app or website using any language supporting RESTful calls. The Perkswall Offers endpoint returns all available Perkswall-enabled offers, allowing publishers to construct their Perkswall in a branded experience.
With the Offer Catalog API, you can fetch a JSON feed containing all the Offers currently provisioned to your account, along with their status, creatives, tracking links, and other associated metadata. This API ensures you have the latest list of Offers and enables real-time status checks before displaying offers to your users.
The Reporting API provides access to statistics like impressions, revenue, clicks, and eCPM (effective cost per mille) related to your account and properties. It helps you track the performance of your advertising efforts.
This checklist ensures that your integration process is thorough and that you're maximizing the benefits of MomentScience. It covers key steps to verify that your integration is complete and effective.
This section provides a list of error codes you may encounter during integration with our API. Having this reference handy will help you troubleshoot any issues that arise more efficiently, ensuring a smoother integration process.
📢 If you're running into any issues while going through the integration process, feel free to contact us at [email protected]