simpaypl/simpay
最新稳定版本:v3.0.7
Composer 安装命令:
composer require simpaypl/simpay
包简介
Official SimPay API
关键字:
README 文档
README
Description
This documentation is intended for current and future Simpay Partners. Prior to implementation, it is necessary to define the service in the Partner Panel and wait for its activation directly from the operators.
Installation & Usage
Requirements
PHP 7.4 and later. Should also work with PHP 8.0.
Composer
To install run composer require simpaypl/simpay
Manual Installation
Download the files and include autoload.php:
<?php require_once('/prject/path/vendor/autoload.php');
Getting Started
<?php require_once(__DIR__ . '/vendor/autoload.php'); $configuration = new Configuration('your_api_key', 'your_api_password', 'en'); $client = new Client([ 'base_uri' => Configuration::API_BASE_URI, ]); $api = new Simpay\DirectBillingApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. $client, $config ); try { $result = $api->directBillingGetServices(); print_r($result); } catch (\Exception $e) { echo 'Exception when calling DirectBillingApi->directbillingGetServices: ', $e->getMessage(), PHP_EOL; }
Examples
All examples are in the examples directory.
Documentation for API Endpoints
API Endpoints
All URIs are relative to https://api.simpay.pl
- Configuration
- DirectBillingApi
- DirectBillingCalculateApi
- DirectBillingTransactionApi
- HttpClientFactory
- PaymentApi
- SmsNumberApi
- SmsServiceApi
- SmsTransactionApi
Models
Requests:
- Amount
- AmountType
- Billing
- CallbackReturnUrl
- CartItem
- Channel
- ChannelType
- Control
- CreatePayment
- Currency
- Customer
- Description
- DirectBillingTransaction
- DirectBillingTransactionStatus
- DirectChannel
- Filters
- Operator
- PaymentTransactionId
- PhoneNumber
- Referer
- ServiceId
- ServiceNumber
- Shipping
- SmsCode
- SmsNumber
- SmsTransactionId
- StreamId
Responses:
- Amount
- AmountType
- CallbackReturnUrl
- DirectBillingTransaction
- DirectBillingTransactionCollection
- DirectBillingTransactionList
- DirectBillingTransactionNotify
- Operator
- Pagination
- PaginationLinks
- PaymentChannel
- PaymentChannelCollection
- PaymentCreate
- PaymentService
- PaymentServiceCollection
- PaymentServiceTransaction
- PaymentServiceTransactionCollection
- PaymentServiceTransactionStatus
- PaymentServiceTransaction
- PaymentServiceTransactionAddress
- PaymentServiceTransactionAmount
- PaymentServiceTransactionCartItems
- PaymentServiceTransactionCustomer
- PaymentServiceTransactionRedirect
- Service
- ServiceCalculation
- ServiceCalculationOperatorAmount
- ServiceCollection
- ServiceNumber
- ServiceStatus
- ServiceType
- SmsNumber
- SmsNumberCollection
- SmsService
- SmsServiceCheckCodeData
- SmsServiceCollection
- SmsTransaction
- SmsTransactionCollection
Exceptions:
- Simpay\Exception\ExceptionFactory
- Simpay\Exception\Forbidden
- Simpay\Exception\InternalServerError
- Simpay\Exception\NotFound
- Simpay\Exception\Unauthorized
- Simpay\Exception\Unknown
- Simpay\Exception\UnprocessableEntity
All the exceptions have the getErrors method which returns an array of errors returned by the API.
Tests
To run the tests, use:
composer install bin/phpunit
Docker
To build the Docker image:
make build
To run the Docker image:
make up
Enter the container (bash):
make bash
To run the tests:
make test
To run the linter:
make lint
About this package
- API version:
1.0.0
统计信息
- 总下载量: 4.05k
- 月度下载量: 0
- 日度下载量: 0
- 收藏数: 3
- 点击次数: 1
- 依赖项目数: 0
- 推荐数: 0
其他信息
- 授权协议: MIT
- 更新时间: 2020-04-19