REGISTER API ACCOUNT

Request: https://vini.az/en/api/register?email={YOUR_EMAIL}&name={YOUR_NAME}
Example response: {“status”:true/false, “key”: “b0d8c6e5ea589e6fc3d3e08afb1873bb”}
Key in response is your private API key for all further requests.

BALANCE CHECK

Request: https://vini.az/en/api/balance?key={API_KEY}
Response: {“balance”:“0.00”}

BALANCE REPLENISH

Request: https://vini.az/en/api/replenish?key={API_KEY}&amount={0.00}
Response: You will be redirected to our bank’s payment page and after submitting payment form you’ll get back to API which will return JSON of payment result.
Example response: {“status”:true/false,“amount”:“100”,“transaction_id”:“OMV5TXAL1Z7S2VMK”}

Note: If status=true, this means the payment was successful, otherwise payment is failed.

Billing Currency
The payment is done in AZN so please make sure to convert desired amount into this currency before proceeding.
Current rate is $1 = ~1.7 AZN, for example: $5.88 = 10 AZN
You may use free currency convertor: https://xe.com)

CHECK REPORT AVAILABILITY

Request: https://vini.az/en/api/check?key={API_KEY}&vin={VIN_NUMBER}&type={REPORT_TYPE}
Response: {“status”:true/false}

VIN: must be a 17 chars long alpha-numeric
Report types available: carfax, autocheck, copart

Note: If the status=true, this means report is available and you can request it

GENERATE REPORT

Request: https://vini.az/en/api/report?key={API_KEY}&vin={VIN_NUMBER}&type={REPORT_TYPE}
Response: report in HTML format or JSON with error

VIN: must be a 17 chars long alpha-numeric
Report types available: carfax, autocheck, copart

Note: If you’ve got a JSON in response, this means there was an error with your request, otherwise your balance will be deducted.
Note: Multiple same requests doesn’t affect your balance, only the first unique request will affect it.

TEST DATA

You may use VIN 12345678901234567 as for the development purposes.
In this case your balance will not be affected and you will bypass some API security filters.

WHITE-LABEL STATIC ASSETS

All links to static content in Carfax report are hardcoded to Vini.az, but you may replace them with your own URL.
In this case you’ll need to download archive with static assets to your own server and replace all “https://vini.az” links.

Download static assets: http://vini.az/carfax_files.rar