Skip to main content
Version: 1.0.0

FameFlow Simulator API

FameFlow Simulator API

Introduction​

The FameFlow Simulator API is designed to simulate influencer activities. In the test environment, we do not send real push notifications to our influencers. However, you can emulate their responses as if they had responded themselves. You have the ability to approve or reject incoming requests, mimicking the actual interaction process with influencers.

Getting Started​

To begin using the API, you need to authenticate by including your API key in the header of your requests. API keys can be obtained by directly contacting us.

Authentication​

  • API Key: Secure your API requests using an API key. Include this key in your request headers as ff-api-key: YOUR_API_KEY. If you do not yet have an API key, please contact us to obtain one.

OpenAPI Specification​

The specification follows the OpenAPI 3.0 format, offering a standardized and comprehensive description that facilitates integration and minimizes client-side errors.

Cross-Origin Resource Sharing (CORS)​

CORS is enabled for all origins, allowing your client-side applications to interact with our API from any web or mobile platform.

Error Handling​

We use standard HTTP response codes to indicate API request outcomes. For errors, the response includes a JSON body with an error key, providing detailed error descriptions.

Key Features​

This functionality is particularly useful for:

  • Testing workflow integrations without the need to involve real influencers.
  • Verifying how your system handles different influencer response scenarios.
  • Training and demonstrations where live data use is not feasible.

Use this API to ensure your application behaves as expected under various scenarios before going live in the production environment.

Authentication​

Secure your API requests using an API key. Include this key in your request headers as ff-api-key: YOUR_API_KEY.

Security Scheme Type:

apiKey

Header parameter name:

ff-api-key