Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #23

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #23

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 21 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,27 @@ PHP 5.3 or above

## Links

1. Yandex.Money API page: [Ru](http://api.yandex.ru/money/),
[En](http://api.yandex.com/money/)
1. Yandex.Money API page: [in Russian](http://api.yandex.ru/money/),
[in English](http://api.yandex.com/money/)
2. [sample app](https://github.com/yandex-money/yandex-money-sdk-php-sample)

## Getting started

### Installation

1. Add `"yandex-money/yandex-money-sdk-php": "3.0.*"` to `composer.json` of your application. Or clone repo to your project.
2. If you are using composer - simply use `require_once 'vendor/autoload.php';` otherwise paste following code
#### With Composer

1. Add `"yandex-money/yandex-money-sdk-php": "3.0.*"` to `composer.json` of your application.

composer require yandex-money/yandex-money-sdk-php:~3.0

2. Simply use the usual `require_once 'vendor/autoload.php';`

#### Manual installation

1. Clone this repo into your project or [download a recent release](https://github.com/yandex-money/yandex-money-sdk-php/releases).

2. Paste following code
```php
// For payments from the Yandex.Money wallet
require_once '/path/to/cloned/repo/lib/api.php';
Expand All @@ -35,18 +46,18 @@ Using Yandex.Money API requires following steps

1. Obtain token URL and redirect user's browser to Yandex.Money service.
Note: `client_id`, `redirect_uri`, `client_secret` are constants that you get,
when [register](https://sp-money.yandex.ru/myservices/new.xml) app in Yandex.Money API.
when [register an app in Yandex.Money API](https://sp-money.yandex.ru/myservices/new.xml).

```php
use \YandexMoney\API;

$auth_url = API::buildObtainTokenUrl($client_id, $redirect_uri, $scope);
```

2. After that, user fills Yandex.Money HTML form and user is redirected back to
2. After that, a user fills Yandex.Money HTML form and the user is redirected back to
`REDIRECT_URI?code=CODE`.

3. You should immediately exchange `CODE` with `ACCESS_TOKEN`.
3. You should immediately exchange `CODE` to `ACCESS_TOKEN`.

```php
$access_token_response = API::getAccessToken($client_id, $code, $redirect_uri, $client_secret=NULL);
Expand Down Expand Up @@ -91,8 +102,8 @@ when [register](https://sp-money.yandex.ru/myservices/new.xml) app in Yandex.Mon

### Payments from bank cards without authorization

1. Fetch instantce-id(ussually only once for every client. You can store
result in DB).
1. Fetch an instance-id. (You usually do that only once for every client. You can store
result in the database.)

```php
use \YandexMoney\ExternalPayment;
Expand All @@ -106,7 +117,7 @@ result in DB).
}
```

2. Make request payment
2. Make payment request.

```php
// make instance
Expand Down