Download the PHP package amattu2/vinwiki-wrapper without Composer
On this page you can find all versions of the php package amattu2/vinwiki-wrapper. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Table of contents
Download amattu2/vinwiki-wrapper
More information about amattu2/vinwiki-wrapper
Files in amattu2/vinwiki-wrapper
Download amattu2/vinwiki-wrapper
More information about amattu2/vinwiki-wrapper
Files in amattu2/vinwiki-wrapper
Vendor amattu2
Package vinwiki-wrapper
Short Description A VINwiki.com API wrapper. Opens up access to VINWiki API functionality; Fetch feeds by a VIN, use plate2vin (pl82vin), add a new event to a feed, etc.
License AGPL-3.0-only
Package vinwiki-wrapper
Short Description A VINwiki.com API wrapper. Opens up access to VINWiki API functionality; Fetch feeds by a VIN, use plate2vin (pl82vin), add a new event to a feed, etc.
License AGPL-3.0-only
Please rate this library. Is it a good library?
Informations about the package vinwiki-wrapper
Introduction
This is an unofficial and dependency-free VINwiki.com API wrapper written PHP. It offers a simple interface for interacting with the VINwiki API. Among other things, it allows you to:
- Read and update user profiles
- Read and update vehicle information
- Read, create, and delete posts
- Decode license plates by country and state
- Search for vehicles by VIN, Year, Make, Model, or free-text
Usage
Installation
Via Composer
Then, require Composer's autoloader:
Instantiate the class:
Functions
People
These functions relate to person interactions.
getPersonProfile(string $uuid = "") : ?VINwiki\Models\Person
Returns a VINwiki user profile. If no user is specified, the current user's profile is returned.updatePersonProfile(string $uuid, VINwiki\Models\Person $person): ?VINwiki\Models\Person
Updates the current user's profile. Returns the updated profile on success. The only required field is "email". See [Models\Person](src/models/Person.php) for more fields.getPersonNotifications() : ?array
Get the current user's notifications.getPersonFeed(string $uuid = "", bool $filterFollowing = true): ?Models\PersonFeed
Get a user's post feed. If no `$uuid` is specified, the current user's feed is returned. If `$filterFollowing` is true, only the posts for vehicles/people that the specified user is following will be returned.getPersonPosts(string $uuid = ""): ?VINwiki\Models\PersonPosts
Get a user's posts. If no user is specified, the current user's posts are returned.getRecentVins(): ?VINwiki\Models\RecentVins
Returns a list of vehicles the user has recently posted on or interacted with. Does not include vehicles that the user has only viewed.Vehicles
These functions handle any vehicle-related interactions.
plateLookup(string $plate, string $country, string $state): ?VINwiki\Models\PlateLookup
Returns a vehicle decoded by the license plate. Currently supports US/UK plates.getFeed(string $vin): ?VINwiki\Models\VehicleFeed
Get a vehicle's post feed (i.e. when you visit a vehicle's page on VINwiki.com)getVehicle(string $vin): ?VINwiki\Models\Vehicle
Get a vehicle's information by VIN.vehicleSearch(string $query): ?VINwiki\Models\VehicleSearch
Perform a free-text search for vehicles by Year, Make, Model, or VIN.updateVehicle(string $vin, int $year, string $make, string $model, string $trim = ""): bool
Update a vehicle's Year, Make, Model, and Trim by VIN. Returns true if successful.createPost(string $vin, VINwiki\Models\VehiclePost $post): ?VINwiki\Models\FeedPost
Create a new post on a vehicle. Requires a VIN and a VehiclePost object. Returns the new post on success. See [Models\VehiclePost](src/models/VehiclePost.php) for more information.deletePost(string $uuid) : bool
Delete a post by UUID. Returns true if successful. Requires the user to be the author of the post.Requirements
- PHP 7.4+
- cURL
- Composer (Preferred)
All versions of vinwiki-wrapper with dependencies
PHP Build Version
Package Version
Requires
php Version
>=7.4
ext-curl Version *
ext-curl Version *
The package amattu2/vinwiki-wrapper contains the following files
Loading the files please wait ....