Dzīvokļu serviss
Ar dzīvokļu servisa palīdzību var izgūt visus vienas adreses dzīvokļus.
Servisa URL
Servisa saitei jāatbilst šādai formai:
https://api.kartes.lv/v3//apartments?`
Atgriezto datu formāts ir JSON.
HTTP metode ir GET.
Pieprasījuma parametri
Iespējams padot šādus GET parametrus:
Parametrs | Skaidrojums |
---|---|
address | Parametrā padod adreses heša vērtību (hash parametrs meklēšanas servisā). |
limit | Parametrs nosaka rezultāta maksimālo objektu skaitu. |
Atbildes parametri
Atbildē tiek atgriezts masīvs ar dzīvokļiem.
Kļūdu kodi
Kods | Skaidrojums |
---|---|
200 | []. Tiek atgriezts, ja nav atrasta adreses heša vērtība. |
400 | no address was passed. Tiek atgriezts, ja vaicājumā nav ievadīta adreses heša vērtība. |
5xx | Servera kļūda. |
Paraugi
Pieprasījums:
https://api.kartes.lv/v3//apartments?address=1395b000c9b0451c7c8fe5ca6de19e76
Atbilde:
[
1,
2,
3,
4
]
Pielietošanas piemēri
Dzīvokļu servisa klases definēšana JavaScript kodā:
class ApartmentApi {
constructor() {
this.apiKey = 'your_api_key_here'; // Replace with your actual API key
this.baseUrl = 'https://api.kartes.lv/v3';
}
// Method to fetch apartment data by address
async getApartmentData(address) {
const url = `${this.baseUrl}/${this.apiKey}/apartments?address=${encodeURIComponent(address)}`;
try {
const response = await fetch(url);
// Check if the response is ok (status code 200-299)
if (!response.ok) {
throw new Error(`Error fetching data: ${response.statusText}`);
}
const data = await response.json();
return { success: true, data };
} catch (error) {
console.error('Fetch error:', error);
return { success: false, error: error.message };
}
}
}
Dzīvokļu servisa pārbaudes klases pielietošana:
const api = new ApartmentAPI();
api.getApartmentData('1395b000c9b0451c7c8fe5ca6de19e76')
.then(result => {
if (!result.success) {
console.error('Error:', result.error); // Handle the error
return;
}
console.log(result.data);
// Use the data
});