API Addons Installation Documentation

Follow these steps to install the addon located in /api-addons on your Sngine website, then connect it to a valid purchase code.

Open Installer Get a License
API Addons Sngine Backend License Required

1. Requirements Before Installation

PHP 8.0 or higher The installer checks the PHP version before allowing the installation to continue.
Required PHP extensions curl and json must be enabled for license verification and API requests.
API Addons files The addon folder must exist in your Sngine root directory as /api-addons.

2. Installation Steps

  1. Upload or copy the addon folder into the Sngine root directory. The final path should look like /www/wwwroot/your-domain.com/api-addons.
  2. Make sure your main Sngine configuration is working and the website opens normally before installing the addon.
  3. Open the installer in your browser: 
    https://your-domain.com/api-addons/install.php
  4. Sign in with your site administrator account if the page asks for authentication.
  5. Review the environment checks on the installer page. All checks must pass before you continue.
  6. Enter the Purchase Code you received from Flutter Crafters Store.
  7. Configure the app colors and OneSignal settings if needed, then submit the installer form.
  8. After a successful installation, you will be redirected to the addon settings panel: 
    https://your-domain.com/api-addons/admin/app-settings/index.php
Installation will not complete if the purchase code is invalid, unpaid, belongs to another product, or is already activated on a different domain.

3. How to Get a License

  1. Open Flutter Crafters Store: 
    https://store.fluttercrafters.com/
  2. Create a new account with Sign Up, or log in with Sign In.
  3. Open the required product page, then choose the license option that fits your use case.
  4. Click Add to Cart or Buy Now, then complete the payment.
  5. After the order is complete, open your store account and go to your purchases or downloads section.
  6. Copy the product Purchase Code, then paste it into: 
    https://your-domain.com/api-addons/install.php
The license is bound to the current domain during installation. Use the same domain that your final app will connect to.

4. After Installation

  • Open the addon settings panel from /api-addons/admin/app-settings/index.php.
  • Check the Licensing page and make sure the license status is active and the activated domain is correct.
  • Test the app settings endpoint: https://your-domain.com/api-addons/app/settings.
  • For future updates, use: https://your-domain.com/api-addons/update.php.

5. Troubleshooting

PHP check failed Upgrade your server PHP version to 8.0 or higher.
curl or json check failed Enable the missing PHP extension from your server control panel, then reload the installer.
Domain mismatch The purchase code is already bound to another domain. Use a new code or contact support if your license terms allow moving the activation.

Flutter Crafters API Addons Documentation