{"id":15562367,"url":"https://github.com/mohammadv184/arvancloud","last_synced_at":"2025-04-23T23:07:08.669Z","repository":{"id":37588996,"uuid":"389164401","full_name":"mohammadv184/arvancloud","owner":"mohammadv184","description":"PHP library for the ArvanCloud API","archived":false,"fork":false,"pushed_at":"2023-04-19T20:09:14.000Z","size":147,"stargazers_count":10,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T23:07:01.035Z","etag":null,"topics":["api","arvan","arvancloud","cdn","cloud","iaas","php","php-arvancloud","vod"],"latest_commit_sha":null,"homepage":"https://arvancloud.com","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mohammadv184.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-24T17:48:12.000Z","updated_at":"2024-03-31T16:43:18.000Z","dependencies_parsed_at":"2025-03-06T19:31:12.214Z","dependency_job_id":"c9dd52e0-b7f9-4e53-9915-4225cd9eae9e","html_url":"https://github.com/mohammadv184/arvancloud","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammadv184%2Farvancloud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammadv184%2Farvancloud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammadv184%2Farvancloud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohammadv184%2Farvancloud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohammadv184","download_url":"https://codeload.github.com/mohammadv184/arvancloud/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250528731,"owners_count":21445516,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","arvan","arvancloud","cdn","cloud","iaas","php","php-arvancloud","vod"],"created_at":"2024-10-02T16:13:51.400Z","updated_at":"2025-04-23T23:07:08.638Z","avatar_url":"https://github.com/mohammadv184.png","language":"PHP","readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"resources/images/arvan-logo.svg\" alt=\"ArvanCloud\"\u003e\u003c/p\u003e\n\n\n# PHP ArvanCloud API\n\n\n[![Latest Stable Version](http://poser.pugx.org/mohammadv184/arvancloud/v)](https://packagist.org/packages/mohammadv184/arvancloud)\n[![Total Downloads](http://poser.pugx.org/mohammadv184/arvancloud/downloads)](https://packagist.org/packages/mohammadv184/arvancloud)\n[![Latest Unstable Version](http://poser.pugx.org/mohammadv184/arvancloud/v/unstable)](https://packagist.org/packages/mohammadv184/arvancloud)\n[![Build Status](https://www.travis-ci.com/mohammadv184/arvancloud.svg?branch=main)](https://www.travis-ci.com/mohammadv184/arvancloud)\n[![License](http://poser.pugx.org/mohammadv184/arvancloud/license)](https://packagist.org/packages/mohammadv184/arvancloud)\n\n\nPHP library for the ArvanCloud API.\nThis package supports `PHP 7.3+`.\n\nFor **Laravel** integration you can use [mohammadv184/arvancloud-laravel](https://github.com/mohammadv184/arvancloud-laravel) package.\n\n# List of contents\n\n- [PHP ArvanCloud API](#PHP-ArvanCloud-API)\n- [List of contents](#list-of-contents)\n- [List of services](#list-of-services)\n    - [Install](#install)\n    - [Configure](#configure)\n    - [How to use service](#how-to-use-service)\n        - [CDN](#CDN)\n    - [Credits](#credits)\n    - [License](#license)\n\n# List of services\n- [CDN](https://www.arvancloud.com/en/products/cdn) :heavy_check_mark:  \n- [Vod](https://www.arvancloud.com/en/products/video-platform) :hourglass:\n- [iaas](https://www.arvancloud.com/en/products/cloud-computing) :hourglass:\n- [VAds](https://www.arvancloud.com/en/products/video-ads) :hourglass:\n\n## Install\n\nVia Composer\n\n``` bash\ncomposer require mohammadv184/arvancloud\n```\n## Configure\n\na. Copy `config/arvancloud.php` into somewhere in your project. (you can also find it in `vendor/mohammadv184/arvancloud/config/arvancloud.php` path).\n\nb. 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.\n\nChoose what Authentication type you would like to use in your application.\n\n```php\n    'auth'=\u003e [\n        'default'  =\u003e 'ApiKey', //Set default Auth Type\n        'UserToken'=\u003e '',\n        'ApiKey'   =\u003e '',//User API Key available in arvancloud panel\n    ],\n    ...\n```\n\nThen fill the credentials for that Service in the services array.\n\n```php\n'services' =\u003e [\n    'cdn' =\u003e [\n        'baseUrl'  =\u003e 'https://napi.arvancloud.com/cdn/4.0/',\n        'domain'   =\u003e 'your_domain.com',// Fill in the credentials here.\n        'endpoints'=\u003e [...],\n    ],\n    ...\n]\n    ...   \n```\n\nc. Instantiate the `ArvanCloud` class and **pass configs to it** like the below:\n\n```php\n    use Mohammadv184\\ArvanCloud\\ArvanCloud;\n\n    // load the config file from your project\n    $config = require('path/to/arvancloud.php');\n\n    $arvanCloud= new ArvanCloud($config);\n```\n\n## How to use service\n\nHow to use ArvanCloud Services.\n\n### CDN\n\nbefore doing any thing you need ArvanCloud Class\n\nIn your code, use it like the below:\n\n```php\n// At the top of the file.\nuse Mohammadv184\\ArvanCloud\\ArvanCloud;\n...\n\n// Create new ArvanCloud.\n$arvanCloud = new ArvanCloud($config);\n\n// Using Cdn Service\n$arvanCloud-\u003ecdn()-\u003edomain('your_domain.com')-\u003eget();\n\n// more Example\n// 1\n$arvanCloud-\u003ecdn()-\u003edomain()-\u003eget('your_domain.com');\n// 2 \n$arvanCloud-\u003ecdn()-\u003edomain()-\u003eall();\n// 3\n$arvanCloud-\u003ecdn()-\u003ecache('your_domain.com')-\u003epurge();\n// 4\n$arvanCloud-\u003ecdn()-\u003edns()-\u003edelete('Dns_id','your_domain.com')\n                    -\u003egetMessage();\n```\nAvailable methods:\n- `domain` :\n  - `all()` : get all domains\n  - `create(string $domain)` : Create New Domain.\n  - `get(string $domain = null)` : Get Domain Settings\n  - `delete(string $domain = null)` : Delete Domain.\n- `cache` : \n  - `get(string $domain = null)` : Get Domain Cache settings.\n  - `update(array $data, string $domain = null)` : Update Domain Cache settings.\n  - `purge(array $urls = null, string $domain = null)` : Purge Domain Cache.\n- `dns` :\n  - `all()` : Get All Domain Dns.\n  - `create(string $domain)` : Create new Domain Dns.\n  - `get(string $domain = null)` : Get Domain Dns Settings.\n  - `update(string $id, array $data, string $domain = null)` : Update Domain Dns Settings.  \n  - `delete(string $domain = null)` : Delete Domain Dns.\n  - `cloud(string $id, bool $status = true, string $domain = null)` : Update Domain Dns Cloud Status.\n  - `import($zoneFile, string $domain = null)` : Import DNS records using BIND file\n- `ssl` :\n  - `get(string $domain = null)` : Get Domain Ssl Settings.\n  - `update(string $sslType, string $domain = null)` : Update Domain Ssl Settings.\n\n## Credits\n\n- [Mohammad Abbasi](https://github.com/mohammadv184)\n- [All Contributors](../../contributors)\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE) for more information.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohammadv184%2Farvancloud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohammadv184%2Farvancloud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohammadv184%2Farvancloud/lists"}