Skip to main content

​
Zonely API Reference

This page lists the lightweight API routes used by Zonely integrations, product license checks, update listeners, announcements, giveaways, season rewards, and user token actions. Use these endpoints when an external product, game server, integration, or licensed script needs to communicate with your Zonely installation.
All endpoints on this page use the GET method unless a future system page states otherwise.

​
Base URL

Replace https://your-domain.com with the domain where Zonely is installed:
Some routes forward the request to an internal handler such as license.php, builtbybit.php, broadcast.php, giveaway.php, or controller.php. The internal target is shown so you can understand which part of the system receives the request.

​
Before You Use The API

  • Use https:// whenever possible.
  • Keep obf_password, token, and license-related values private.
  • URL-encode values that may contain spaces, slashes, special characters, or non-English characters.
  • Test each endpoint with a browser, Postman, Insomnia, or a small server-side request before using it in production.
  • If an endpoint uses {ip}, pass the real requester or server IP expected by your license logic.
Do not expose private license keys, product IDs, or user tokens in public client-side JavaScript unless the specific integration is designed for public use.

​
Endpoint Summary

​
License Verification

Use this endpoint when a product or external script needs to verify a Zonely license.
Internal target:

​
BuiltByBit License Verification

Use this endpoint for BuiltByBit-linked license verification.
Internal target:
Required parameters are the same as the main license verification route.

​
Alternative BuiltByBit Route

Some integrations may use the longer BuiltByBit license path:
Internal target:

​
Announcements And Giveaway

​
License Announcements

Internal target:
Use this route when licensed products or integrations need to fetch announcement data.

​
Giveaway Check

Internal target:
Use this route for giveaway-related checks or integration listeners.

​
Season Reward Distribution

This route runs the season reward distribution flow.
Run this endpoint intentionally. If your installation uses scheduled tasks, make sure the route is called only at the correct season-end time.

​
Update And Version Routes

​
Update Hook

Internal target:

​
Legacy Update Version

Internal target:
Use this only when an older integration expects the legacy version route.

​
New Update Listener

Internal target:
Use this route for newer product update listeners.

​
Active Code Verification

Internal target:
Use this route when an integration needs to check active code data for a product.

​
User Token Routes

​
Token With Discord

Internal target:

​
Token With Name Information

Internal target:

​
Testing Checklist

Before using an endpoint in production:
  • Confirm the domain and route are correct.
  • Replace every placeholder value.
  • Test with the same product ID and IP that the real integration will use.
  • Check whether the endpoint returns the expected response or forwards to the expected internal handler.
  • Keep a note of the request URL used by the external product or server.

​
Common Issues

The endpoint returns an unexpected result
Check the product ID, encrypted password value, IP value, and whether the related product/license record exists. The request works in the browser but not in the external product
Check firewall rules, SSL configuration, user agent restrictions, and whether the external product encodes URL parameters correctly. A user token route does not update the account
Check that the token is valid, the language code is supported, and the Discord/name values are passed in the expected format. A season or reward endpoint runs at the wrong time
Review the scheduled task or external trigger that calls the route.