Download the PHP package apirone/apirone-sdk-php without Composer
On this page you can find all versions of the php package apirone/apirone-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package apirone-sdk-php
Apirone SDK PHP
This Library provides classes for working with Apirone invoices. Easy integration of cryptocurrency payments.
- Requirements
- Installation and preparation for use
- Assets configure
- Database and Logs handlers
- Settings
- Create an Invoice
- Get an existing invoice
- Callbacks handler
- Show invoice
- Render loader
- Render AJAX response
- Examples and playground
- Support
- License
Requirements
- PHP 7.4 or higher with cURL and JSON extentions. Tested up to 8.2.
- MySQL or MariaDB
- Apirone API PHP
Installation and preparation for use
Use composer for library installation.
composer require apirone/apirone-sdk-php
Assets configure
Copy folder into your public html.
On the invoice display page you need to add and js/script.js
from assets folder. Also, you can use minimized versions.
Database and Logs handlers
To connect library to your database-engine you need to create two callback functions and pass them to the library.
Db handler example for php MySQLi
For logging you can use a callback function or logger implementation Psr/Log/LoggerInterface
Log callback example:
Psr/Log example:
Set handlers to the library:
Create an invoice table:
You can create a common file to set up an account class and include it in your code
Settings
The settings class is used to create an account, manage currency settings, and save and restore the settings object.
Create a new settings object:
Load an existing settings object
Create an Invoice
Get an existing invoice
Callbacks handler
Apirone service interacts with the library through callbacks. To get invoice statuses, you need to create a URL and add a callback handler to your code. This address must be set when creating a new invoice.
If you need to process the order status based on the status of the invoice, you can create a callback function to handle the status change.
Show invoice
Render loader
To display the invoice, use the function. Also, a style file and js script should be added to the page template from the assets folder.
Render AJAX response
To update the invoice data, you need to create a URL and add the renderAjaxResponse() function to the code. This URL used as parameter.
Examples and playground
In the folder, you can find a ready-made implementation of the library usage.
You can also run the playground. To run the playground, you need Docker and Docker Compose installed.
To do this, you need to copy the file from the folder to the library root folder and run the command:
docker-compose up -d --build
After the start of the containers, the playground will be available in the browser at http://localhost
Support
License
MIT License
Copyright (c) © 2017-2023. Apirone. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.