Shoffi Docs
  • πŸ‘‹Getting Started
  • πŸ’»For App Owners
    • Adding a new app
    • Google Analytics integration
    • The affiliate terms
    • Managing affiliates
    • Invite affiliates
    • Paying affiliates
    • Managing your apps
    • Managing your team
    • Integrations (Webhooks)
  • πŸ’³Subscriptions
    • Choosing/Upgrading a plan
    • Plan limits
    • Changing billing details
    • Downgrade and cancellation
    • Frozen and Deactivated accounts
  • πŸ”€The Shoffi API
    • Introduction to Shoffi API
    • Get All Affiliates
    • Get Affiliate Info
    • Create New Affiliate
    • Update Affiliate Terms
    • Affiliate Payment Request
  • πŸ”—For Affiliates
    • Connecting to new apps
    • Referral links
    • Manual referrals
    • Payout requests
    • Performance analytics
    • Connected app Information
  • General
    • The markets
    • The affiliate commision
    • Disputes
Powered by GitBook
On this page
  • Endpoint URL
  • Authentication
  • You Shoffi App API key
  • Additional Information
  1. The Shoffi API

Introduction to Shoffi API

PreviousFrozen and Deactivated accountsNextGet All Affiliates

Last updated 7 months ago

The Shoffi API is available for the Growth, Pro, and Enterprise plans. Learn more on the page.

Endpoint URL

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/

Authentication

To ensure the security and integrity of our API, all requests to the Shoffi API require authentication. To authenticate, you must include the correct API token key.

You Shoffi App API key

Every app has its authentication key. You must use the apiKey and appId in your API calls to Shoffi.

Your API key is in your Shoffi dashboard under My apps > Edit App.

Additional Information

API Affiliates Accounts

Affiliates won’t get emails from Shoffi until they log in and complete the signup in the Shoffi platform.

Plan Limits

Use Cases

For every affiliate that you sign up using the API, Shoffi will open an affiliate account on our platform. If an affiliate would like to log in to Shoffi, they can use the "" page with their email address and log in to the Shoffi platform to view all their information.

The API feature is available to specific subscription plans, with different call limits per plan. For more details, please visit the.

Get inspired and learn more about using the Shoffi API in .

πŸ”€
Reset password
pricing page
this blog post
Shoffi Pricing
Your shoffi key