Download the PHP package marketscan/mscan without Composer

On this page you can find all versions of the php package marketscan/mscan. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of marketscan/mscan

Informations about the package mscan

MarketScan mScan API client in PHP

This is a PHP client for the MarketScan mScan API.

This library is written, maintained, and used by MarketScan customers. For help with this client library, please open an issue or pull request. If you're having credential or other MarketScan problems, please contact their excellent API support team at [email protected]

Getting Started

You can install this library through Composer:

In your code, instantiate the API client by passing your Partner ID and Account number to the constructor. Optionally you can pass in the root URL as the third argument.

Commands

Looking up vehicles

The most powerful way to look up vehicles is using GetVehiclesByVINParams.

You can look up a specific vehicle by VIN by passing that as the only parameter:

You can also pass a more detailed query object that uses the MarketScan VIN exploder to search your inventory. See documentation for details.

You can get a complete list of Makes and Models. Each call takes one parameter, if true it returns Makes or Models that are currently New, if false it returns Makes and Models that may be available used (e.g., DMC, Plymouth).

Get Manufacturer Information

You can get a complete list of supported manufacturers. This information rarely changes and can be cached.

You can also get the manufacturer of a specific vehicle (by MarketScan Vehicle ID):

Information About Your Dealership

You can look up the code MarketScan uses to describe your region by looking up the ZIP code of your dealership:

Etc.

The entire API has not yet been mapped to PHP methods yet. (Pull requests are welcome!) If you need an API method that is not yet implemented directly, the general form for API calls is:

Some of these API actions, especially RunScan, offer incredibly fine-grained control. If you need help figuring out what options can be passed, check out MarketScan's API documentation.

Demo Pages

The library includes demo code to take a VIN and return a matrix of Lease and Retail Loan payments. To run the demo:

  1. Clone this repository
  2. In the repo folder, run composer install to load dependencies and set up the autoloader.
  3. cp demo/credentials-sample.php demo/credentials.php then update credentials.php with actual MarketScan credentials from your account team. (This new file will be ignored by git if you commit changes for a pull request.)
  4. Start the PHP local server: php -S localhost:4242 -t demo
  5. Open your browser to http://localhost:4242

Getting to RunScan

There is a lot of good stuff in the MarketScan API, but the very best stuff is in RunScan results.

To build your request object to pass to RunScan for a vehicle (assuming you're starting with its VIN):

  1. Set Vehicle.ID to the value you received from $mscan->GetVehiclesByVINParams($vin)
  2. Set AutoRebateParams.ZIP to the customer's ZIP
  3. Set AutoRebateParams.DealerZIP to the dealer's ZIP
  4. Set Market to the dealership's market ID you received from $mscan->GetMarketByZIP($zip) (the market ID can be cached indefinitely)

All versions of mscan with dependencies

PHP Build Version
Package Version
Requires guzzlehttp/guzzle Version ~6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package marketscan/mscan contains the following files

Loading the files please wait ....