flipeaz342 / ubiqfy-php-sdk
PHP SDK for the Ubiqfy API, providing access to mobile products, transactions, and international services.
Installs: 1
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 0
Open Issues: 0
pkg:composer/flipeaz342/ubiqfy-php-sdk
Requires
- php: ^8.1
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
README
This SDK provides a PHP client for the Ubiqfy API, allowing developers to integrate mobile product offerings, handle transactions, and access international services seamlessly.
Installation & Usage
Requirements
PHP 8.1 and later.
Composer
To install the bindings via Composer:
composer require flipeaz342/ubiqfy-php-sdk
Or, add the following to composer.json:
{
"require": {
"flipeaz342/ubiqfy-php-sdk": "^1.0"
}
}
Then run composer install
Manual Installation
Download the files and include autoload.php:
<?php require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
Getting Started
Please follow the installation procedure and then run the following:
<?php require_once(__DIR__ . '/vendor/autoload.php'); $apiInstance = new OpenAPI\Client\Api\PartnersAPIApi( // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`. // This is optional, `GuzzleHttp\Client` will be used as default. new GuzzleHttp\Client() ); $request = new \OpenAPI\Client\Model\AuthenticateRequest(); // \OpenAPI\Client\Model\AuthenticateRequest try { $result = $apiInstance->partnersAPIAuthenticate($request); print_r($result); } catch (Exception $e) { echo 'Exception when calling PartnersAPIApi->partnersAPIAuthenticate: ', $e->getMessage(), PHP_EOL; }
API Endpoints
All URIs are relative to https://api.ubiqfy.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| PartnersAPIApi | partnersAPIAuthenticate | POST /Authenticate | |
| PartnersAPIApi | partnersAPICancelTransaction | POST /CancelTransaction | |
| PartnersAPIApi | partnersAPIDoCalculateEstimatePrice | POST /DoCalculateEstimatePrice | |
| PartnersAPIApi | partnersAPIDoTransaction | POST /DoTransaction | |
| PartnersAPIApi | partnersAPIGetAvailableProduct | POST /GetAvailableProduct | |
| PartnersAPIApi | partnersAPIGetAvailableProductByCode | POST /GetAvailableProductByCode | |
| PartnersAPIApi | partnersAPIGetAvailableProductOptionByCode | POST /GetAvailableProductOptionByCode | |
| PartnersAPIApi | partnersAPIGetAvailableProductTypes | POST /GetAvailableProductTypes | |
| PartnersAPIApi | partnersAPIGetCountries | POST /GetCountries | |
| PartnersAPIApi | partnersAPIGetInternationalMobileProducts | POST /GetInternationalMobileProducts | |
| PartnersAPIApi | partnersAPIGetInternationalOperators | POST /GetInternationalOperators | |
| PartnersAPIApi | partnersAPIGetInternationalPhoneNumberOptions | POST /GetInternationalPhoneNumberOptions | |
| PartnersAPIApi | partnersAPIGetProductOptionPhoneNumber | POST /GetProductOptionPhoneNumber | |
| PartnersAPIApi | partnersAPIGetTransaction | POST /GetTransaction |
Models
- APICancelTransactionRequest
- APICancelTransactionResponse
- ApplyPaymentResultData
- ApplyTransactionRequest
- ApplyTransactionResponse
- AuthenticateRequest
- AuthenticateResponse
- AvailableCountries
- AvailableCountriesRequest
- AvailableCountriesResponse
- AvailableInternationalMobileProduct
- AvailableInternationalMobileProductsRequest
- AvailableInternationalMobileProductsResponse
- AvailableInternationalOperator
- AvailableInternationalOperatorsRequest
- AvailableInternationalOperatorsResponse
- AvailableProduct
- AvailableProductOption
- AvailableProductOptionByCodeRequest
- AvailableProductOptionByCodeResponse
- AvailableProductOptionRequest
- AvailableProductOptionResponse
- AvailableProductOptions
- AvailableProductRequest
- AvailableProductResponse
- AvailableProductTypes
- AvailableProductTypesRequest
- AvailableProductTypesResponse
- AvailableProducts
- AvailableProductsRequest
- AvailableProductsResponse
- CalculateEstimatePriceRequest
- CalculateEstimatePriceResponse
- Country
- EzeTopCalculateError
- EzeTopCalculateEstimatePrices
- EzeTopCalculateEstimatedPrice
- EzeTopCalculatePrice
- EzeTopError
- EzeTopGetProductsResponse
- EzeTopInternationalDialingInformation
- EzeTopPrice
- EzeTopProduct
- EzeTopSetting
- EzeTopSettingDefinition
- GetInternationalPhoneNumberOptionsRequest
- GetInternationalPhoneNumberOptionsResponse
- GetTransactionRequest
- GetTransactionResponse
- MandatoryFields
- MinMaxFaceRangeValue
- MinMaxRangeValue
- TransationData
- VisibleFields
Authorization
Endpoints require authorization.
Tests
To run the tests, use:
composer install vendor/bin/phpunit
Author
About this package
This PHP package is automatically generated by the OpenAPI Generator project:
- API version:
v1- Generator version:
7.17.0
- Generator version:
- Build package:
org.openapitools.codegen.languages.PhpClientCodegen