Aby skorzystać z naszego API, musisz wykonać żądanie HTTP GET do naszego punktu końcowego. Każde żądanie składa się z trzech kluczowych elementów: identyfikatora użytkownika API, klucza API oraz numeru VIN pojazdu. Dodatkowo musisz wygenerować sumę kontrolną MD5, aby zapewnić bezpieczeństwo żądań.
API UID
Identyfikator użytkownika przypisany po aktywacji konta.
API Key
Klucz API używany do autoryzacji użytkownika.
VIN
Numer VIN pojazdu do dekodowania.
Lang
Ten opcjonalny parametr definiuje język, w którym dane są zwracane przez dekoder. Obsługiwane wartości to en (angielski), pl (polski), de (niemiecki), i wiele innych..
Checksum
Suma kontrolna MD5 generowana na podstawie kombinacji UID API + Klucz API + VIN.
Przykład żądania API w PHP
PHP
<?php
// API data
$api_uid = "USERID"; // Enter your API UID
$api_key = "APIKEY"; // Enter your API Key
// VIN to be entered
$vin = "VINNUMBER"; // Enter the VIN number
// Preferred language for API response
$lang = "en"; // Set the preferred language, e.g., 'en' for English etc.
// Generating checksum as MD5
$checksum = md5($api_uid . $api_key . $vin);
// API URL with language parameter
$url = "https://bp.autoiso.pl/api/v3/getDecoderFree/apiuid:$api_uid/checksum:$checksum/vin:$vin/lang:$lang";
// Initializing cURL session
$ch = curl_init();
// cURL settings
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); // Get the response as a variable
curl_setopt($ch, CURLOPT_HTTPGET, true);
// Execute the request
$response = curl_exec($ch);
// Check if an error occurred
if (curl_errno($ch)) {
echo 'cURL error: ' . curl_error($ch);
} else {
echo "API response:\n";
echo $response;
$responseData = json_decode($response, true);
print_r($responseData);
}
// Close the cURL session
curl_close($ch);
?>
Opis działania przykładowego kodu
Opis funkcjonalności przykładowego kodu
1
$api_uid i $api_key - To są unikalne dane uwierzytelniające dostarczone przez nas, które musisz uwzględnić w swoim kodzie, aby autoryzować żądania.
2
$vin - Numer VIN pojazdu, który chcesz zdekodować.
3
$checksum - Suma kontrolna MD5 jest generowana przez połączenie danych użytkownika z numerem VIN, aby zapewnić autoryzację żądania.
4
$lang - Ten parametr definiuje język, w którym dane są zwracane przez dekoder. Możesz wybierać spośród następujących wartości językowych:
bgbułgarski
csczeski
daduński
deniemiecki
eeestoński
elgrecki
eshiszpański
frfrancuski
hrchorwacki
huwęgierski
itwłoski
ltlitewski
lvłotewski
nlholenderski
nonorweski
plpolski
ptportugalski
rorumuński
rurosyjski
sksłowacki
slsłoweński
srserbski
svszwedzki
trturecki
uaukraiński
enangielski (domyślny)
5
cURL - Używany do zainicjowania sesji i wykonania żądania HTTP GET do naszego API, po czym zwracana jest odpowiedź, która może być następnie przetworzona i wyświetlona.
Opis struktury odpowiedzi
"analyze"
Zawiera wprowadzony i poprawiony numer VIN wraz z szczegółami takimi jak rok produkcji zakodowany w VIN oraz numer seryjny pojazdu.
"manufacturer"
Informacje o producencie pojazdu, w tym adresy i region produkcji.
"decoder"
Dane związane z pojazdem:
Marka i model pojazdu,
Rok produkcji i numer seryjny,
Typ nadwozia, liczba drzwi, typ paliwa oraz inne parametry techniczne, takie jak moc silnika i typ skrzyni biegów,
"custom_equipment"
Lista dodatkowego wyposażenia w pojeździe, takiego jak klimatyzacja, podgrzewane siedzenia, ABS.
Poniżej znajduje się specyfikacja OpenAPI dla przykładowej odpowiedzi z naszego API dekodera VIN. Zawiera strukturę zwracanych danych pojazdu, takich jak szczegóły producenta, specyfikacje techniczne (moc silnika, typ paliwa, standard emisji) oraz lista dodatkowego wyposażenia. Ta specyfikacja może służyć jako punkt odniesienia podczas wdrażania naszego API w Twojej aplikacji, ułatwiając integrację i zapewniając prawidłowe przetwarzanie zwróconych informacji.
OpenAPI 3.0.0
openapi: 3.0.0
info:
title: VIN Decoder API
version: '1.0'
description: API to decode VIN and obtain vehicle information.
servers:
- url: https://bp.autoiso.pl/api/v3
paths:
/getDecoderFree/apiuid:{apiuid}/checksum:{checksum}/vin:{vin}/lang:{lang}:
get:
summary: Decoding the VIN number
parameters:
- name: apiuid
in: path
required: true
description: Unique API user identifier
schema:
type: string
- name: checksum
in: path
required: true
description: MD5 checksum (apiuid + api_key + VIN)
schema:
type: string
- name: vin
in: path
required: true
description: Vehicle Identification Number (VIN) for decoding
schema:
type: string
- name: lang
in: path
required: true
description: Response language code
schema:
type: string
responses:
'200':
description: The response contains decoded vehicle information.
content:
application/json:
schema:
type: object
properties:
analyze:
type: object
manufacturer:
type: object
decoder:
type: object
custom_equipment:
type: object
Oferta dostępu
Nasze API dekodera VIN to dedykowane narzędzie dla klientów biznesowych, oferujące globalny zasięg i szybki dostęp do szczegółowych informacji o pojazdach. Dzięki zaawansowanemu dekodowaniu VIN użytkownicy otrzymują kompleksowe dane techniczne, takie jak rok produkcji, marka, model, typ nadwozia, typ paliwa, moc silnika oraz specyfikacje wyposażenia.
API wspiera szeroki zakres branż związanych z motoryzacją:
Salony samochodowe
Umożliwia natychmiastowy dostęp do danych technicznych pojazdów, przyspieszając procesy sprzedaży i zakupu.
Firmy ubezpieczeniowe
Dokładne dane o pojazdach pozwalają na lepszą ocenę ryzyka i wycenę polis.
Warsztaty i centra serwisowe
Warsztaty i centra serwisowe - Szczegółowe specyfikacje techniczne ułatwiają szybszą identyfikację części i bardziej efektywne naprawy.
Portale motoryzacyjne i ogłoszenia
Portale motoryzacyjne - Dekodowanie VIN dostarcza szczegółowych informacji do ogłoszeń pojazdów, zwiększając wiarygodność ofert.
Dzięki naszemu API dekodera VIN możesz cieszyć się szeregiem korzyści:
✓
Globalny zasięg
Wsparcie dla wielu rynków i marek na całym świecie, zapewniając dostęp do danych z różnych regionów.
Natychmiastowy dostęp do pełnych danych technicznych pojazdu skraca czas wymagany na procesy weryfikacji, przyspieszając sprzedaż, naprawy lub oceny ubezpieczeniowe.
Warunki handlowe
Koszt jednego żądania do naszego API wynosi 0,20 Euro. Aby zapewnić przewidywalne koszty, obowiązuje minimalna wartość faktury miesięcznej wynosząca 50 Euro. Oznacza to, że niezależnie od liczby żądań złożonych w ciągu miesiąca, faktura nie będzie niższa niż 50 Euro.
Na przykład:
• Jeśli złożysz tylko 5 żądań (łącznie 1 Euro), Twoja faktura wyniesie 50 Euro.
Ten model rozliczeniowy zapewnia pełną elastyczność w dostosowywaniu liczby żądań do Twoich potrzeb, przy jednoczesnym utrzymaniu minimalnych kosztów dostępu do naszego API.
Ciągły rozwój i ograniczenia API
Nasze API jest regularnie aktualizowane, aby dostarczać coraz bardziej szczegółowe i dokładne dane. Ważne jest jednak, aby zauważyć, że pełna dostępność informacji może zależeć od różnych czynników, takich jak źródła danych, regionalne standardy produkcji oraz ograniczenia w weryfikacji danych w czasie rzeczywistym.
Zachęcamy do kontaktu z nami w celu omówienia szczegółów integracji i korzyści płynących z korzystania z naszego API dla Twojego biznesu.
Oferta dostępu
Zachęcamy do kontaktu z nami w celu omówienia szczegółów integracji i korzyści płynących z korzystania z naszego API dla Twojego biznesu.