README

This module is a connector library for the insanely fast CNIC Backend APIs (CentralNic Reseller, internet.bs, moniker). Do not hesitate to contact us in case of questions.

Resources

• Documentation Links (PHP-SDK internal registrar id available in round brackets):
  • CentralNic Reseller (CNR)
  • Internet.bs (IBS)
  • Moniker (MONIKER)
• Release Notes

Usage

composer require centralnic-reseller/php-sdk

Find a demo app for the Brand of choice in the examples folder that should help you with getting started.

e.g. examples/app_CNR.php etc.

Dev Container

If you want to contribute, we recommend using Visual Studio Code and to follow the below setup instructions:

• Add an entry in your hosts file: 127.0.0.1 devsdk.centralnicreseller.net

PHP SDK Data can be accessed via apache server at this url: http://devsdk.centralnicreseller.net

Environment variables (env.sh)

The devcontainer looks for an env.sh file in the workspace root and automatically sources it in two places:

1. Every new integrated-terminal session — the file is sourced via ~/.zshenv so credentials are available as soon as you open a terminal, without a manual source env.sh.
2. PHPUnit runs triggered from the VSCode UI — the PHPUnit wrapper script sources env.sh before invoking PHP, so IDE-triggered tests see the same variables as composer test does from the terminal.

env.sh is listed in .gitignore and will never be committed. Create it once in the workspace root with the variables you need — copy env.example.sh as a starting point.

Note

The auto-loading takes effect for new terminal sessions. If your terminal was already open when you created or updated env.sh, run source env.sh once in that session or open a new terminal.

Running the Demo Application

To run the demo application, follow these steps:

1. Set Your Credentials: You need to ensure your credentials are available. The recommended approach inside the devcontainer is to create an env.sh file in the workspace root — see Environment variables (env.sh) for details. Alternatively, you can directly replace the credential placeholders inside the demo application file.

2. Execute the Demo: Once the credentials are configured, run the appropriate demo command:

   Run the below npm scripts (or execute the related commands covered in package.json):

   # CentralNic Reseller
   npm run test-demo-cnr
   # internet.bs
   npm run test-demo-ibs
   # Moniker
   npm run test-demo-moniker

3. Update Demo Contents: If you need to modify the demo contents, the relevant files are located at:

   # CentralNic Reseller
   examples/app_CNR.php
   # internet.bs
   examples/app_IBS.php
   # Moniker
   examples/app_MONIKER.php
   

CI / Testing

CI is powered by reusable GitHub Actions workflows. The test matrix covers:

The matrix is configured via the repository variable RTLDEV_MW_CI_PHP_MATRIX.

Maintainers

• Kai Schwarz - KaiSchwarz-cnic
• Asif Nawaz - KaiSchwarz-cnic

License

This project is licensed under the MIT License - see the LICENSE file for details.