Download the PHP package visualappeal/php-ssllabs-api without Composer
On this page you can find all versions of the php package visualappeal/php-ssllabs-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download visualappeal/php-ssllabs-api
More information about visualappeal/php-ssllabs-api
Files in visualappeal/php-ssllabs-api
Package php-ssllabs-api
Short Description API for ssllabs.com
License GPL-3.0-only
Informations about the package php-ssllabs-api
PHP-SSLLabs-API
This PHP library provides basic access to the SSL Labs API.
Installation
composer require visualappeal/php-ssllabs-api
Usage
It's build upon the official API documentation at https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md
Methods
info()
No parameters needed
Returns an Info object (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#info).
getStatusCodes()
No parameters needed
Returns a StatusCodes instance (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#statuscodes).
analyze()
See https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#invoke-assessment-and-check-progress for parameter description.
Parameter | Type | Default value | |
---|---|---|---|
host | string | Required | |
publish | boolean | false | |
startNew | boolean | false | |
fromCache | boolean | false | |
maxAge | int | null | |
all | string | null | |
ignoreMismatch | boolean | false |
Returns a Host object (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#host).
Make sure to check the 'status' attribute inside Host object.
analyzeCached()
You can also use fetchHostInformation() with the proper parameters, this is just a helper function.
Parameter | Type | Default value | |
---|---|---|---|
host | string | Required | |
maxAge | int | null | |
publish | boolean | false | |
ignoreMismatch | boolean | false |
Returns a Host object (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#host).
Also make sure to check the 'status' attribute inside Host object.
getEndpointData()
See https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#retrieve-detailed-endpoint-information for parameter description.
Parameter | Type | Default value | |
---|---|---|---|
host | string | Required | |
s | string | Required | |
fromCache | boolean | false |
Returns an Endpoint object (see https://github.com/ssllabs/ssllabs-scan/blob/master/ssllabs-api-docs.md#endpoint).
Custom API calls
Use sendApiRequest() method to create custom API calls.
Parameter | Type | Default value | |
---|---|---|---|
apiCall | string | Required | |
parameters | array |
getReturnObjects()
Getter for returnObjects
setReturnObjects()
Setter for returnObjects
Parameter | Type | Default value | |
---|---|---|---|
returnObjects | boolean | Required |
Example output (as JSON strings)
Get API information
Get host information
Get endpoint information
(just an except of the entire JSON output)
Terms and Conditions
As this is just a PHP library for SSL Labs API please refer to SSL Labs terms and conditions at https://www.ssllabs.com/about/terms.html