Adreses pārbaudes serviss
Serviss ļauj veikt adreses verifikāciju pēc parametriem.
Servisa URL
Servisa saitei jāatbilst šādai formai:
https://api.kartes.lv/v3//verify_address?
Noklusētais atgriezto datu formāts ir JSON.
HTTP metode ir GET.
Pieprasījuma parametri
Iespējams padot šādus GET parametrus:
Parametrs | Skaidrojums |
---|---|
iela | Iela. |
maja | Mājas numurs vai viensētas nosaukums. (obligāts) |
valsts | Valsts. |
admin_vien | Administratīvā vienība. (obligāts) |
terit_vien | Teritoriālā vienība. (obligāts) |
apdz_vieta | Apdzīvotā vieta. |
index | Pasta indekss. |
korpuss | Mājas korpuss. |
Atbildes parametri
Atbildē tiek atgriezts atrasto adrešu skaits.
Kļūdu kodi
Kods | Skaidrojums |
---|---|
200 | Wrong input data. Tiek atgriezts, ja vaicājumā nav ievadīti vai nav korekti ievadīti pieprasījuma parametri. |
404 | No location found. Tiek atgriezts, ja nekas nav ticis atrasts. |
5xx | Servera kļūda. |
Paraugi
Pieprasījums:
https://api.kartes.lv/v3//verify_address?valsts=Latvija&iela=Krasta iela&maja=105A&admin_vien=Rīga&apdz_vieta=Rīga&terit_vien=Latgales priekšpilsēta&index=LV-1019
Atbilde:
{"address":1}
Pieprasījums:
https://api.kartes.lv/v3//verify_address?valsts=Latvija&maja=Saulesteteri&admin_vien=Saulkrastu novads&terit_vien=Sējas pagasts
Atbilde:
{"address":1}
Pielietošanas piemēri
Adreses pārbaudes klases definēšana JavaScript kodā:
class VerifyAddressApi {
constructor() {
this.apiKey = 'your_api_key_here'; // Replace with your actual API key
this.baseUrl = 'https://api.kartes.lv/v3';
}
// Method to verify address
async verifyAddress({country, street, house, admin_unit, place, territ_unit, index}) {
const params = new URLSearchParams({
valsts: country,
iela: street,
maja: house,
admin_vien: admin_unit,
apdz_vieta: place,
terit_vien: territ_unit,
index: index
});
const url = `${this.baseUrl}/${this.apiKey}/verify_address?${params.toString()}`;
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 };
}
}
}
Adreses pārbaudes klases pielietošana:
const api = new VerifyAddressAPI();
api.verifyAddress({
country: 'Latvija',
street: 'Krasta iela',
house: '105A',
admin_unit: 'Rīga',
place: 'Rīga',
territ_unit: 'Latgales priekšpilsēta',
index: 'LV-1019'
})
.then(result => {
if (!result.success) {
console.error('Error:', result.error); // Handle the error
return;
}
console.log('Address count:', result.data.address);
// Use the data
});