Integraatio-ohje
JavaScript / Node.js -integraatio
Delivery Zone API on JSON-päätepiste. Kutsu sitä funktiolla fetch tai kirjastolla axios Node.js:ssä — Express-reitissä, Next.js API -reitissä, Netlify-funktiossa tai missä tahansa palvelinpuolen JavaScript-ajoympäristössä.
Milloin API:a kutsutaan
Kutsu rajapintaa palvelinpuolen reitinkäsittelijässä — älä React/Vue-komponenteissa tai selaimen skripteissä. API-avaimen on pysyttävä palvelimella.
Tärkeää: pidä API-avaimet palvelimella: Älä koskaan kutsu rajapintaa selaimessa ajettavasta JavaScriptistä. API-avaimesi on sijaittava palvelimen ympäristömuuttujassa. Esimerkiksi
NEXT_PUBLIC_-etuliite paljastaisi sen — älä tee niin.
Koodiesimerkki
// Server-side only — never expose your API key in browser code
async function checkDelivery(postcode, basketValueCents) {
const res = await fetch("https://api.deliveryzone.fi/api/v1/delivery/check", {
method: "POST",
headers: {
"X-Api-Key": process.env.DZ_KEY,
"Content-Type": "application/json",
},
body: JSON.stringify({ destinationPostcode: postcode, basketValueCents }),
});
return res.json();
}
Virheenkäsittely
Kun canDeliver on false (tai null), vastaus sisältää reasonCode-kentän. Näytä tämä asiakkaalle:
NOT_DELIVERABLE— postinumero on toimitusalueidesi ulkopuolella tai sitä ei tunnisteta (rajapinta käyttää tarkoituksella yhtä yleistä koodia molemmille vyöhykerajojen suojaamiseksi)MINIMUM_ORDER_NOT_MET— ostoskorin arvo alittaa vyöhykkeen vähimmäistilauksenBASKET_VALUE_REQUIRED— ostoskorin arvo tarvitaan tämän kohteen vähimmäistilaus- tai ilmaistoimitussäännön arvioimiseksi
Käsittele aina HTTP-virheet (5xx, aikakatkaisu) hallitusti. Jos rajapinta ei ole tavoitettavissa, toimi turvallisesti — hylkää tilaus tai ohjaa se manuaaliseen tarkistukseen.
Käyttöönottolista
- Kutsu rajapintaa palvelinreitissä, älä asiakaskomponentissa
- Tallenna avain tiedostoon
.envnimelläDZ_KEY— älä koskaan käytä NEXT_PUBLIC_-etuliitettä - Käsittele fetch-virheet ja muut kuin 200-vastaukset
- Validoi postinumeron muoto ennen rajapinnan kutsumista
- Testaa ei-tuotantovyöhykkeellä ennen tuotantokäyttöä
Valmis ottamaan postinumerotarkistuksen käyttöön?
Ilmainen aloitus. Ei luottokorttia. Aito käyttöönottoapu.