README

Installation & Usage

Requirements

PHP 7.1 and later. Should also work with PHP 8.0 but has not been tested.

This library implement php-http (HTTPPlug) to let you use your own http client with adapter HTTPlug is an abstraction that allows this library to support many different HTTP Clients. Therefore, you need to provide it with an adapter for the HTTP library you prefer. You can find all the available adapters in Packagist. This documentation assumes you use the Guzzle5 Client, but you can replace it with any adapter that you prefer.

The recommended way to install stan-business/stan-php is through Composer:

composer require stan-business/stan-php php-http/guzzle5-adapter

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "stan-business/stan-php": "*@master"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Stan/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP basic authorization: stan_basic_auth
$config = Stan\Configuration::getDefaultConfiguration()
              ->setClientId('YOUR_API_CLIENT_ID')
              ->setClientSecret('YOUR_API_CLIENT_SECRET');

$stan_client = new Stan\Api\StanClient($config);
$connect_access_token_request_body = new \Stan\Model\ConnectAccessTokenRequestBody(); // \Stan\Model\ConnectAccessTokenRequestBody

try {
    $result = $stan_client->connectApi->createConnectAccessToken($connect_access_token_request_body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConnectApi->createConnectAccessToken: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.stan-app.fr/v1

Class	Method	HTTP request	Description
ConnectApi	create	POST /oauth/token	Create an access token to request user's infos
CustomerApi	create	POST /customers	Create a new customer
PaymentApi	create	POST /payments	Create a payment
PaymentApi	getPayment	GET /payments/{payment_id}	Get a payment
PaymentApi	getPayments	GET /payments	Get all payments
RefundApi	create	POST /refunds	Create a refund
RefundApi	getRefund	GET /refunds/{refund_id}	Get a refund
RefundApi	getRefunds	GET /refunds	Get all refunds
ApiSettings	updateApiSettings	PUT /apis	Updates API settings
UserApi	getUser	GET /sessions/users	Get user infos

Models

Authorization

stan_basic_auth

Type: HTTP basic authentication

stan_connect_auth

Type: OAuth
Flow: accessCode
Authorization URL: https://api.stan-app.fr/v1/oauth/auth
Scopes:
- openid: Specify that you will be requesting personnal data
- email: Specify that you will be requesting the user's email address
- phone: Specify that you will be requesting the user's phone number
- profile: Specify that you will be requesting the user's fullname
- address: Specify that you will be requesting the user's delivery address

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

Brightweb

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

stan-business / stan-php

Maintainers

Details