Ver 0.1 (Alpha version, response in JSON format) HTTP/HTTPs interface

This version of API (Application Programming Interface) uses for sending request to web-service simple HTML form with method POST and answer in JSON format.

Status: active, Alpha version
Last edition: 2016-12-02
WEB protocol: HTTP/HTTPs
Authorization method: session cookies
Entry point: http://api.carinfo.kiev.ua, https://api.carinfo.kiev.ua

General section

Request form:

Quote:

<form action="https://api.carinfo.kiev.ua" method="post" id="form1">
<input name="Pversion" type="text" value="%s" />
<input name="user" type="text" value="%s" />
<input name="pass" type="text" />
<input name="mode" type="text" value="%s" />
<input name="reptype" type="text" value="%s" />
<input name="refid" type="text" value="%s" />
<input name="lang" type="text" value="%s" />
<input name="brand" type="text" value="%s" />
<input name="vinnumber" type="text" value="%s" />
<input type="submit" value="Send" />
</form>

Where input fields are:

Pversion - version of protocol used for processing this request (0.1); Obligatory parameter;
user - user's name on site (author of request); Obligatory parameter;
pass - user's password on site; Is used only during login;
mode - mode of request (check VIN, report of last activity, login and so on); Obligatory parameter;
reptype - variant of report; Obligatory parameter for mode = "report";
refid - user's defined identificator of request; Will be returned in answer without modification; Optional parameter;
lang - language of requested data; Obligatory parameter with mode = "check";
brand - brand of requested VIN for checking; Obligatory parameter with mode = "check";
vinnumber - regeuested VIN for checking; Obligatory parameter with mode = "check";

Answer (general structure):

Quote:

(
    [header] =>
        (
            ...
        )

    [system_messages] =>

        (

            [system_news] => 

            [news] => 

            [personal_news] => 

            [attention] => 

        )

    [data] =>

        (

            ...

        )

    [messages] => 

)

Where output chapters are:

header - chapter with parameters of request and status code;
system_messages - reserved chapter;
data - chapter with a "body" of answer; its content depends on the type of request;

messages - reserved chapter;

Typical workflow

Login in web-service:

Quote:

<form action="https://api.carinfo.kiev.ua" method="post" id="form1">

<input name="Pversion" type="text" value="0.1" />

<input name="user" type="text" value="myusername" />

<input name="pass" type="text" value="mypassword" />

<input name="mode" type="text" value="login" />

<input name="refid" type="text" value="-1" />

</form>

Answer from web-service:

Success:

Quote:

(

    [header] =>

        (

            [response_code] =>

                (

                    [200] => You are welcome, myusername!

                )

            [user] => myusername

            [uid] => 2

            [Pversion] => 0.1

            [mode] => login

            [refid] => -1

        )

)

Fail:

Quote:

(

    [header] =>

        (

            [response_code] =>

                (

                    [403] => Invalid user myusername or password

                )

            [Pversion] => 0.1

            [mode] => login

            [refid] => -1

        )

)

With this answer your application will get session cookies, which must be send with any request to web-service. Usually lifetime of cookies is measured by the weeks. If cookies become invalid answer from web-service on any request will be like this:

Quote:

(

   [header] =>

        (

            [response_code] =>

                (

                    [403] => Access denied. Please login

                )

            [Pversion] => 0.1

            [refid] => -1

        )

)

With this answer you must login again.

Checking the VIN

Request form:

Quote:

<form action="https://api.carinfo.kiev.ua" method="post" id="form1">

<input name="Pversion" type="text" value="0.1" />

<input name="user" type="text" value="myusername" />

<input name="mode" type="text" value="check" />

<input name="refid" type="text" value="1480700056" />

<input name="lang" type="text" value="en" />

<input name="brand" type="text" value="mercedes-benz" />

<input name="vinnumber" type="text" value="WDB1240191J016310" />

<input type="submit" value="Send" />

</form>

Where input fields are:

Pversion - version of protocol used for processing this request (0.1); Obligatory parameter;
user - user's name on site (author of request); Obligatory parameter;
mode - mode of request; here it's "check";
refid - user's defined identificator of request; Will be returned in answer without modification; Optional parameter;
lang - language of requested data; parameter is case sensitive;
brand - brand of requested VIN for checking; parameter is case insensitive; in answer brand will be converted to upper case;
vinnumber - regeuested VIN for checking;

Chapter "data" in answer has a structure, fully identical to usual online page: It's an array of names of tables, and each of them is an array of fields in it. Answer for this request will be the next:

Quote:

For better understanding of structure of answer you can compare it with online page, which is placed in way [data]->[Main data]->[Permanent link].

Other service functions

Available brands and languages for requesting

Request form:

Quote:

<form action="https://api.carinfo.kiev.ua" method="post" id="form1">

<input name="Pversion" type="text" value="0.1" />

<input name="user" type="text" value="myusername" />

<input name="mode" type="text" value="report" />

<input name="reptype" type="text" value="modules" />

<input name="refid" type="text" value="a125fg" />

<input type="submit" value="Send" />

</form>

Answer

Quote:

(

    [header] =>

        (

            [reptype] => modules

            [response_code] =>

                (

                    [200] => Ok

                )

            [Pversion] => 0.1

            [mode] => report

            [refid] => a125fg

        )

    [data] =>

        (

            [byBrand] =>

                (

                    [BMW] =>

                        (

                            [0] => ru

                            [1] => en

                            [2] => fr

                            [3] => de

                            [4] => es

                            [5] => pt

                        )

                    [BMW MOTORRAD] => Array

                        (

                            [0] => ru

                            [1] => en

                            [2] => fr

                            [3] => de

                            [4] => es

                            [5] => pt

                        )

                    ...

                )

            [byLang] =>

                (

                    [ru] =>

                        (

                            [0] => BMW

                            [1] => BMW MOTORRAD

                            [2] => CITROEN

                            ...

                        )

                    [en] => Array

                        (

                            [0] => BMW

                            [1] => BMW MOTORRAD

                            [2] => CHRYSLER

                            ...

                        )

                    ...

                )

        )

)

Last requests

Request form:

Quote:

<form action="https://api.carinfo.kiev.ua" method="post" id="form1">

<input name="Pversion" type="text" value="0.1" />

<input name="user" type="text" value="myusername" />

<input name="mode" type="text" value="report" />

<input name="reptype" type="text" value="accesslog" />

<input name="refid" type="text" value="dada11156" />

<input type="submit" value="Send" />

</form>

Answer:

Quote:

(

    [header] =>

        (

            [reptype] => accesslog

            [response_code] =>

                (

                    [200] => Ok

                )

            [Pversion] => 0.1

            [mode] => report

            [refid] => dada11156

        )

    [data] =>

        (

            [1] =>

                (

                    [brand] => BMW

                    [vin] => WBADP71050GS76523

                    [datetime] => 2016-12-04 11:01:52 +0300

                    [lang] => en

                )

            [2] =>

                (

                    [brand] => RENAULT

                    [vin] => VF1JZ090347945106

                    [datetime] => 2016-12-04 11:00:13 +0300

                    [lang] => en

                )

            [3] =>

                (

                    [brand] => RENAULT

                    [vin] => VF1BB0FBF24659201

                    [datetime] => 2016-12-04 10:59:42 +0300

                    [lang] => en

                )

            ....

        )

)

Where parameter [datetime] - it's a time of request with time zone settings in user's profile on site. Relative offset to UTC (GMT) is added at the end.

Mon, 2020-10-19 22:23 — elia

Re: Ver 0.1 (Alpha version, response in JSON format)

Hello Team ,

Trying to use Checking the VIN after login API but receiving the following response.

{"header":{"response_code":{"400":"Bad Request. You have no rights for this
interface."},"Pversion":"0.1","mode":"check","refid":"1480700056"}}

I am using Postman to test using form-data.

As the documentation says I can test up 3 lookups for free.

Hello Qasim,
API is not available for freeware use.
Complete answer you will get in the Email.

Fri, 2020-10-16 12:20 — qasim (not verified)

Hello Team ,

Trying to use Checking the VIN after login API but receiving the following response.

{"header":{"response_code":{"400":"Bad Request. You have no rights for this
interface."},"Pversion":"0.1","mode":"check","refid":"1480700056"}}

I am using Postman to test using form-data.

As the documentation says I can test up 3 lookups for free.

Tue, 2019-04-16 08:39 — elia

Re: Issue while accessing api.

How to access this api's results at my site. is it free of cost ? i am getting this json result {"header":{"response_code":{"403":"Access denied. Please login"},"Pversion":"0.1","mode":"check","refid":"1480700056"}}

Hello,
API is not free of charge. Conditions of use are described here: https://carinfo.kiev.ua/payed_access

Tue, 2019-04-16 00:40 — Anonymous

CARInfo

Материалы

Друзья

API (Application Programming Interface)

User login