Download the PHP package ocolin/wisdm without Composer
On this page you can find all versions of the php package ocolin/wisdm. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package wisdm
WISDM
What is it?
This is a PHP REST client for the WISDM API interface. WISDM is a service for wireless ISPs that provide the ability to determine which areas are serviceable from a wireless access point.
Table of Contents
- What is it?
- Requirements
- Installation
- Configuration
- Instantiation with environment variables
- Instantiation with constructor arguments
- Optional arguments
- Response
- Path Parameter Interpolation
- Methods
- GET
- POST
- PATCH
- DELETE
- REQUEST
- UPLOAD
Requirements
- ^PHP 8.2
- guzzlehttp/guzzle ^7.10
- ocolin/global-type ^2.0
Installation
Configuration
Wisdm requires two pieces of information. The server hostname, and your authentication token/key. These can be configured via environment or though constructor arguments using a Config data object.
| Environment name | Constructor argument | Type | Description |
|---|---|---|---|
| WISDM_API_HOST | $host | string | Server hostname |
| WISDM_API_KEY | $token | string | Authentication key/token |
Instantiation with environment variables
Instantiation with constructor arguments
Optional arguments
You can also pass along Guzzle HTTP configuration options such as HTTP timeouts, verification of SSL, etc different from the defaults.
Response
The client responds with an object containing the following properties:
| Name | Type | Description |
|---|---|---|
| status | integer | HTTP status code |
| statusMessage | string | HTTP status message |
| headers | array | HTTP response headers |
| contentType | string | HTTP body content type |
| body | object|array | API payload body |
Path Parameter Interpolation
Any elements or properties of a \$query argument that match variable tokens in the URI endpoint path will be replaced with the values for those elements in the $query array or object. Please see some of the method functions for examples.
Methods
GET
Get a resource from the API.
POST
Create a resource on the API.
PATCH
Update a resource on the API.
DELETE
Delete a resource on the API.
REQUEST
In case changes are made to the API, a generic request function is available.
UPLOAD
Several API calls use a multi-part request body for uploading files and data. The uploads() function can be used for those.