Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohammadv184/arvancloud
PHP library for the ArvanCloud API
https://github.com/mohammadv184/arvancloud
api arvan arvancloud cdn cloud iaas php php-arvancloud vod
Last synced: 3 months ago
JSON representation
PHP library for the ArvanCloud API
- Host: GitHub
- URL: https://github.com/mohammadv184/arvancloud
- Owner: mohammadv184
- License: mit
- Created: 2021-07-24T17:48:12.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-19T20:09:14.000Z (over 1 year ago)
- Last Synced: 2024-10-09T16:50:02.189Z (3 months ago)
- Topics: api, arvan, arvancloud, cdn, cloud, iaas, php, php-arvancloud, vod
- Language: PHP
- Homepage: https://arvancloud.com
- Size: 144 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# PHP ArvanCloud API
[](https://packagist.org/packages/mohammadv184/arvancloud)
[](https://packagist.org/packages/mohammadv184/arvancloud)
[](https://packagist.org/packages/mohammadv184/arvancloud)
[](https://www.travis-ci.com/mohammadv184/arvancloud)
[](https://packagist.org/packages/mohammadv184/arvancloud)
PHP library for the ArvanCloud API.
This package supports `PHP 7.3+`.
For **Laravel** integration you can use [mohammadv184/arvancloud-laravel](https://github.com/mohammadv184/arvancloud-laravel) package.
# List of contents
- [PHP ArvanCloud API](#PHP-ArvanCloud-API)
- [List of contents](#list-of-contents)
- [List of services](#list-of-services)
- [Install](#install)
- [Configure](#configure)
- [How to use service](#how-to-use-service)
- [CDN](#CDN)
- [Credits](#credits)
- [License](#license)
# List of services
- [CDN](https://www.arvancloud.com/en/products/cdn) :heavy_check_mark:
- [Vod](https://www.arvancloud.com/en/products/video-platform) :hourglass:
- [iaas](https://www.arvancloud.com/en/products/cloud-computing) :hourglass:
- [VAds](https://www.arvancloud.com/en/products/video-ads) :hourglass:
## Install
Via Composer
``` bash
composer require mohammadv184/arvancloud
```
## Configure
a. Copy `config/arvancloud.php` into somewhere in your project. (you can also find it in `vendor/mohammadv184/arvancloud/config/arvancloud.php` path).
b. In the config file you can set the Config to be used for all your Service and you can also change the Config at runtime.
Choose what Authentication type you would like to use in your application.
```php
'auth'=> [
'default' => 'ApiKey', //Set default Auth Type
'UserToken'=> '',
'ApiKey' => '',//User API Key available in arvancloud panel
],
...
```
Then fill the credentials for that Service in the services array.
```php
'services' => [
'cdn' => [
'baseUrl' => 'https://napi.arvancloud.com/cdn/4.0/',
'domain' => 'your_domain.com',// Fill in the credentials here.
'endpoints'=> [...],
],
...
]
...
```
c. Instantiate the `ArvanCloud` class and **pass configs to it** like the below:
```php
use Mohammadv184\ArvanCloud\ArvanCloud;
// load the config file from your project
$config = require('path/to/arvancloud.php');
$arvanCloud= new ArvanCloud($config);
```
## How to use service
How to use ArvanCloud Services.
### CDN
before doing any thing you need ArvanCloud Class
In your code, use it like the below:
```php
// At the top of the file.
use Mohammadv184\ArvanCloud\ArvanCloud;
...
// Create new ArvanCloud.
$arvanCloud = new ArvanCloud($config);
// Using Cdn Service
$arvanCloud->cdn()->domain('your_domain.com')->get();
// more Example
// 1
$arvanCloud->cdn()->domain()->get('your_domain.com');
// 2
$arvanCloud->cdn()->domain()->all();
// 3
$arvanCloud->cdn()->cache('your_domain.com')->purge();
// 4
$arvanCloud->cdn()->dns()->delete('Dns_id','your_domain.com')
->getMessage();
```
Available methods:
- `domain` :
- `all()` : get all domains
- `create(string $domain)` : Create New Domain.
- `get(string $domain = null)` : Get Domain Settings
- `delete(string $domain = null)` : Delete Domain.
- `cache` :
- `get(string $domain = null)` : Get Domain Cache settings.
- `update(array $data, string $domain = null)` : Update Domain Cache settings.
- `purge(array $urls = null, string $domain = null)` : Purge Domain Cache.
- `dns` :
- `all()` : Get All Domain Dns.
- `create(string $domain)` : Create new Domain Dns.
- `get(string $domain = null)` : Get Domain Dns Settings.
- `update(string $id, array $data, string $domain = null)` : Update Domain Dns Settings.
- `delete(string $domain = null)` : Delete Domain Dns.
- `cloud(string $id, bool $status = true, string $domain = null)` : Update Domain Dns Cloud Status.
- `import($zoneFile, string $domain = null)` : Import DNS records using BIND file
- `ssl` :
- `get(string $domain = null)` : Get Domain Ssl Settings.
- `update(string $sslType, string $domain = null)` : Update Domain Ssl Settings.
## Credits
- [Mohammad Abbasi](https://github.com/mohammadv184)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE) for more information.