README

Introduction

This package provides the ability to use Rade Company's conversion and inquiry services for PHP and Laravel applications.

For organizational use, please contact our colleagues through the support panel or email.

• Rade Website
• Rade User Panel
• support@rade.ir
• مستندات فارسی

Installation

Install via composer:

composer require radeir/sdk

Usage

Using in Plain PHP

<?php
use Radeir\Services\RadeServices;

// Configuration
$config = [
    'username' => 'your_username',
    'password' => 'your_password',
    'scopes' => ['scope1', 'scope2'],
    'baseUrl' => 'https://api.rade.ir/api'
];

// Create service instance
$radeServices = new RadeServices($config);

// Use services
try {
   // Documentation for each service is available in the Services section below
} catch (\Radeir\Exceptions\RadeException $e) {
    // Error handling
    echo "Error: " . $e->getMessage();
}

Using in Laravel

1. Publish the configuration file:

php artisan vendor:publish --provider="Radeir\Provider\RadeServiceProvider"

2. Set environment variables in .env file:

RADE_USERNAME=your_username
RADE_PASSWORD=your_password
RADE_SCOPES=scope1,scope2
RADE_BASE_URL=https://api.example.com

3. Using the Facade in Laravel:

<?php
use Radeir\Facade\Rade;

// Convert card number to IBAN
$ibanInfo = Rade::cardToIban('6037991234567890');

// Convert card number to deposit account
$depositInfo = Rade::cardToDeposit('6037991234567890');

// Documentation for each service is available in the Services section below

4. Using Dependency Injection:

<?php
use Radeir\Services\RadeServices;

class MyController
{
    public function index(RadeServices $radeServices)
    {
        // Documentation for each service is available in the Services section below
        $ibanInfo = $radeServices->cardToIban('6037991234567890');
        return response()->json($ibanInfo);
    }
}

Services

This package provides the following services:

• Bank card number to Iban
• Bank card number to Deposit account
• Deposit account to Iban
• Iban inquiry
• Iban owner verification
• Shahkar

For more information about token management and save, please refer to the Token Management Documentation.

Contributing

For information on how to contribute to this project, please refer to the Contribution Guide.