Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/muetze42/virus-total-php
This package is a wrapper for the VirusTotal.com API V3.
https://github.com/muetze42/virus-total-php
laravel php php8 security virusscan virustotal
Last synced: about 2 months ago
JSON representation
This package is a wrapper for the VirusTotal.com API V3.
- Host: GitHub
- URL: https://github.com/muetze42/virus-total-php
- Owner: Muetze42
- License: mit
- Created: 2023-08-17T21:25:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-10-02T20:49:32.000Z (about 1 year ago)
- Last Synced: 2024-03-15T14:11:28.811Z (9 months ago)
- Topics: laravel, php, php8, security, virusscan, virustotal
- Language: PHP
- Homepage: https://developers.virustotal.com/reference/overview
- Size: 24.4 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# VirusTotal API for PHP & Laravel
This package is a wrapper for the [VirusTotal.com API V3](https://developers.virustotal.com/reference/overview).
## Installation
```
composer require norman-huth/virus-total-php
```
### Instruction
This wrapper have a method for each API endpoint with title in `camelCase` format.
The following alias methods have been defined to allow a more comfortable handling:
| Method | Alias for |
|----------------------|-----------------------------------------------------------------------------------------------------------------|
| `scanIP()` | `getAnIPAddressReport()` |
| `scanDomain()` | `getADomainReport()` |
| `scanFile()` | Depending on the file size (determined automatically):
`uploadAFile()` or `getAURLForUploadingLargeFiles()` |
| `analyseUrlOrFile()` | `getAURLOrFileAnalysis()` |
The endpoints are output in the following array:
````php
return [
'status' => 'int', # Response HTTP status code
'successful' => 'bool' # True if the response HTTP status code is between 200 & 299,
'data' => 'array|string' # The content from the API. If the response have a single `data` key, then the `data` content returns
];
````
**Notice: If you disable `http_errors`, an exception will be thrown on unsuccessful requests.**
### Usages
* [PHP Usage](USAGE-PHP.md)
* [Laravel Usage](USAGE-LARAVEL.md)