Introduction to Shoffi API
Last updated
The Shoffi API is available for the Pro and Enterprise plans. Learn more on the Shoffi Pricing page.
The Shoffi API is constructed according to REST principles, making it easy for authenticated users to interact with any of our URIs using the appropriate HTTP request method. To ensure the highest level of security, we enforce TLS encryption by requiring that all requests are sent via HTTPS.
https://platform.shoffi.app/API/To ensure the security and integrity of our API, all requests to the Shoffi API require authentication. To authenticate, you must include your Shoffi API Key and your app's appId.
Every app can have its own Shoffi API Key. You must use the apiKey and appId fields in the body of your API calls to Shoffi.
This key is not the same as the key shown under My Apps → Edit app. That key is only for the post-install request. For the API:
Open Integrations in the left-hand menu of your Shoffi dashboard.
Select the API Key tab.
Click Create key for the app you want to use.
Copy the key immediately — for security, it is shown only once.
If you lose the key, revoke it and create a new one.
For every affiliate you create using the API, Shoffi opens an affiliate account on our platform. If an affiliate wants to log in to Shoffi, they can use the Reset password page with their email address and then log in to view their information.
Affiliates won’t get emails from Shoffi until they log in and complete the signup in the Shoffi platform.
The API feature is available on specific subscription plans, with different call limits per plan. For more details, visit the pricing page.
Get inspired and learn more about using the Shoffi API in this blog post.
Last updated