https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk

https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk
• Owner: centralnicgroup-opensource
• License: mit
• Created: 2021-08-31T07:39:12.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T08:55:45.000Z (about 2 years ago)
• Last Synced: 2024-05-13T10:01:17.934Z (about 2 years ago)
• Language: PHP
• Size: 1.47 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# php-sdk

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Build Status](https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/workflows/Release/badge.svg?branch=master)](https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/workflows/Release/badge.svg?branch=master)

[![Packagist](https://img.shields.io/packagist/v/centralnic-reseller/php-sdk.svg)](https://packagist.org/packages/centralnic-reseller/php-sdk)

[![PHP from Packagist](https://img.shields.io/packagist/php-v/centralnic-reseller/php-sdk.svg)](https://packagist.org/packages/centralnic-reseller/php-sdk)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)

[![PRs welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/blob/master/CONTRIBUTING.md)

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)](https://support.centralnicreseller.com/hc/en-gb/articles/13513253776285-Self-Development-Kit-for-PHP)

    * [Internet.bs (IBS)](https://faq.internetbs.net/hc/en-gb/articles/24953916500381-Self-Development-Kit-for-PHP)

    * [Moniker (MONIKER)](https://support.moniker.com/hc/en-gb/articles/24954146333981-Self-Development-Kit-for-PHP)

* [Release Notes](https://github.com/centralnicgroup-opensource/rtldev-middleware-php-sdk/releases)

## Usage

```composer require centralnic-reseller/php-sdk```

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

e.g. `tests/CNR/app.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```

## Running the Demo Application

To run the demo application, follow these steps:

1. **Set Your Credentials**:

   You need to ensure your credentials are available. You can do this in two ways:

   - Directly replace the credentials within the application file.

   - Alternatively, set the environment variables required for the CNR test app:

     ```sh

     # CentralNic Reseller

     export RTLDEV_MW_CI_USER_CNR=

     export RTLDEV_MW_CI_USERPASSWORD_CNR=

     # internet.bs

     export RTLDEV_MW_CI_USER_IBS=

     export RTLDEV_MW_CI_USERPASSWORD_IBS=

     # moniker

     export RTLDEV_MW_CI_USER_MONIKER=

     export RTLDEV_MW_CI_USERPASSWORD_MONIKER=

     ```

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):

    ```sh

    # 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:

   ```plaintext

   # CentralNic Reseller

   tests/CNR/app.php

   # internet.bs

   tests/IBS/app.php

   # Moniker

   tests/MONIKER/app.php

   ```

## Authors

* **Kai Schwarz** - *development* - [KaiSchwarz-cnic](https://github.com/kaischwarz-cnic)

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.