Skip to main content

Documentation Index

Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide walks you through the end-to-end journey for building and deploying a Core Extension: from getting sandbox access, through building and testing your app, to certification and production deployment. By the end, you will have a working extension that loads inside Nayax Core and authenticates your users.

​
What you’ll need

  • A Nayax developer account with sandbox access (provided by Nayax after onboarding)
  • A hosted web application you control (your extension runs in an iframe inside Nayax Core)
  • Familiarity with the Core Extension overview and the extension types
Core Extension is not available for self-registration. Nayax provisions your sandbox access and manually registers your app in Nayax Core. Contact your Nayax representative to begin the onboarding process.
1

Get sandbox access

Nayax sends you a welcome email with your sandbox credentials and environment details. The sandbox is a full Nayax Core environment where you can test your extension end-to-end before submitting for certification.Once you have access, verify that you can log in to the sandbox Nayax Core instance at the URL provided in the welcome email.
2

Choose your hosting approach

Your extension runs as a web application hosted at a URL that Nayax Core loads in an iframe. You can host it on your own infrastructure or, in some cases, on Nayax-provided infrastructure.Host your application at a publicly accessible HTTPS URL. You will provide this URL to Nayax when your app is registered in the sandbox menu.
3

Implement the required integrations

Before you can test your extension end-to-end, implement the four areas the App Framework requires.Authentication: Receive the JWT token Nayax passes to your app at load time and use it for all Nayax API calls.Extension Types: Choose the display type that fits your use case (Screen, Fullscreen, Button with Popup, or Tab) and implement the matching token delivery method.Translations: Wrap all user-visible text in the translation function so Nayax Core can serve your UI in the user’s language.Role-Based UI Visibility: Register the UI elements your app exposes so Nayax Core administrators can control visibility by role.
4

Register your app in the sandbox

Once your application is hosted and the integrations are in place, provide Nayax with:
  • The URL of your hosted application
  • The display type you are using (Screen, Fullscreen, Button with Popup, or Tab)
  • The menu location where your app should appear
  • The scopes your app requires (if any)
Nayax registers your app in the Nayax Core sandbox menu manually. You will receive confirmation once your app is visible in the sandbox environment.
5

Test in sandbox

With your app registered, log in to the sandbox Nayax Core as a user who has access to your menu item. Verify:
  • Your extension loads at the correct URL
  • You receive a valid JWT token (check your browser console or network tab)
  • API calls made with the token return the expected data
  • UI text displays in the correct language when you switch the Nayax Core language setting
  • Role-controlled elements show and hide correctly based on the user’s role
6

Submit for certification

When your extension passes testing in the sandbox, contact Nayax to request certification. Nayax reviews your app before approving it for production.
7

Deploy to production

After certification, Nayax registers your app in the production Nayax Core environment. Deploy your application to your production hosting infrastructure and verify that it loads correctly with the production JWT public key.See Authentication for the production public key and token validation details.

​
Summary

You have walked through the full Core Extension lifecycle: sandbox access, implementation, sandbox registration and testing, certification, and production deployment. The next steps are to implement each technical area in detail using the guides below.

Authentication

Receive and validate the JWT token.

Extension Types

Choose and implement the right display type.

Translations

Expose your UI strings for multi-language support.

Role-Based Visibility

Declare which UI elements are role-controllable.