Download the PHP package user10/raas without Composer

On this page you can find all versions of the php package user10/raas. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of user10/raas

Informations about the package raas

Getting started

With this RESTful API you can integrate a global reward or incentive program into your app or platform. If you have any questions or if you'd like to receive your own credentials, please contact us at [email protected].

How to Build

The generated code has dependencies over external libraries like UniRest. These dependencies are defined in the file that comes with the SDK. To resolve these dependencies, we use the Composer package manager which requires PHP greater than 5.3.2 installed in your system. Visit https://getcomposer.org/download/ to download the installer file for Composer and run it in your system. Open command prompt and type . This should display the current version of the Composer installed if the installation was successful.

Building SDK - Step 1

[For Windows Users Only] Configuring CURL Certificate Path in php.ini

CURL used to include a list of accepted CAs, but no longer bundles ANY CA certs. So by default it will reject all SSL certificates as unverifiable. You will have to get your CA's cert and point curl at it. The steps are as follows:

  1. Download the certificate bundle (.pem file) from https://curl.haxx.se/docs/caextract.html on to your system.
  2. Add curl.cainfo = "PATH_TO/cacert.pem" to your php.ini file located in your php installation. “PATH_TO” must be an absolute path containing the .pem file.

How to Use

The following section explains how to use the Raas library in a new project.

1. Open Project in an IDE

Open an IDE for PHP like PhpStorm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.

Open project in PHPStorm - Step 1

Click on in PhpStorm to browse to your generated SDK directory and then click .

Open project in PHPStorm - Step 2

2. Add a new Test Project

Create a new directory by right clicking on the solution name as shown below:

Add a new project in PHPStorm - Step 1

Name the directory as "test"

Add a new project in PHPStorm - Step 2

Add a PHP file to this project

Add a new project in PHPStorm - Step 3

Name it "testSDK"

Add a new project in PHPStorm - Step 4

Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable auto loading of classes.

It is important that the path inside require_once correctly points to the file inside the vendor directory created during dependency installations.

Add a new project in PHPStorm - Step 4

After this you can add code to initialize the client library and acquire the instance of a Controller class. Sample code to initialize the client library and using controller methods is given in the subsequent sections.

3. Run the Test Project

To run your project you must set the Interpreter for your project. Interpreter is the PHP engine installed on your computer.

Open from menu.

Run Test Project - Step 1

Select from within

Run Test Project - Step 2

Browse for Interpreters near the option and choose your interpreter.

Run Test Project - Step 3

Once the interpreter is selected, click

Run Test Project - Step 4

To run your project, right click on your PHP file inside your Test project and click on

Run Test Project - Step 5

How to Test

Unit tests in this SDK can be run using PHPUnit.

  1. First install the dependencies using composer including the require-dev dependencies.
  2. Run vendor\bin\phpunit --verbose from commandline to execute tests. If you have installed PHPUnit globally, run tests using phpunit --verbose instead.

You can change the PHPUnit test configuration in the phpunit.xml file.

Initialization

Authentication

In order to setup authentication and initialization of the API client, you need the following information.

Parameter Description
platformName RaaS v2 API Platform Name
platformKey RaaS v2 API Platform Key

API client can be initialized as following.

Class Reference

List of Controllers

Class: OrdersController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: createOrder

TODO: Add a method description

Parameters

Parameter Tags Description
body TODO: Add a parameter description

Example Usage

Method: getOrder

TODO: Add a method description

Parameters

Parameter Tags Description
referenceOrderID Reference Order ID

Example Usage

Method: getOrders

TODO: Add a method description

Parameters

Parameter Tags Description
accountIdentifier TODO: Add a parameter description
customerIdentifier TODO: Add a parameter description
externalRefID TODO: Add a parameter description
startDate TODO: Add a parameter description
endDate TODO: Add a parameter description
elementsPerBlock TODO: Add a parameter description
page TODO: Add a parameter description

Example Usage

Method: createResendOrder

TODO: Add a method description

Parameters

Parameter Tags Description
referenceOrderID TODO: Add a parameter description

Example Usage

Back to List of Controllers

Class: AccountsController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getAccount

Get an account

Parameters

Parameter Tags Description
accountIdentifier Account Identifier

Example Usage

Method: getAccountsByCustomer

Gets a list of accounts for a given customer

Parameters

Parameter Tags Description
customerIdentifier Customer Identifier

Example Usage

Method: createAccount

Create an account under a given customer

Parameters

Parameter Tags Description
customerIdentifier Customer Identifier
body Request Body

Example Usage

Method: getAllAccounts

Gets all accounts under the platform

Example Usage

Back to List of Controllers

Class: CatalogController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getCatalog

Get Catalog

Example Usage

Back to List of Controllers

Class: ExchangeRatesController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getExchangeRates

Retrieve current exchange rates

Example Usage

Back to List of Controllers

Class: StatusController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getSystemStatus

Tags:

Retrieve system status

Example Usage

Back to List of Controllers

Class: CustomersController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getCustomer

Get a customer

Parameters

Parameter Tags Description
customerIdentifier Customer Identifier

Example Usage

Method: createCustomer

Create a new customer

Parameters

Parameter Tags Description
body Request Body

Example Usage

Method: getAllCustomers

Gets all customers under the platform

Example Usage

Back to List of Controllers

Class: FundController

Get singleton instance

The singleton instance of the class can be accessed from the API Client.

Method: getCreditCards

List all credit cards registered on this platform

Example Usage

Method: createCreditCard

Register a new credit card

Parameters

Parameter Tags Description
body TODO: Add a parameter description

Example Usage

Method: createUnregisterCreditCard

Unregister a credit card

Parameters

Parameter Tags Description
body TODO: Add a parameter description

Example Usage

Method: createDeposit

Fund an account

Parameters

Parameter Tags Description
body TODO: Add a parameter description

Example Usage

Method: getDeposit

Get details for a specific credit card deposit

Parameters

Parameter Tags Description
depositId Deposit ID

Example Usage

Method: getCreditCard

Get details for a specific credit card

Parameters

Parameter Tags Description
token Card Token

Example Usage

Back to List of Controllers

All versions of raas with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4.0
ext-curl Version *
ext-json Version *
ext-mbstring Version *
mashape/unirest-php Version ~3.0.1
apimatic/jsonmapper Version ~1.3.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package user10/raas contains the following files

Loading the files please wait ....