Fiberadresse-oppslag

Denne API-endepunktet lar deg søke etter tilgjengelighet på en norsk adresse i vårt dekningskart.

URL

GET https://api.hkbb.no/address-lookup/?gatenavn=Solvang&postnr=5521

Autentisering

Bruk Authorization: Bearer <token> i header.

Forespørselsparametre

Parameter Beskrivelse Eksempel Obligatorisk
gatenavnDeler av gatenavnSolvangNei
husnrHusnummer12Nei
postnrPostnummer (4 siffer)5521Nei
poststedNavn på stedHaugesundNei

Eksempel (cURL)

curl -X GET "https://api.hkbb.no/address-lookup/?gatenavn=Solvang&postnr=5521" \
-H "Authorization: Bearer <ditt-token>"
            

Eksempel på respons (JSON)

[
  {
    "leveransepunktid": "54321",
    "leveransepunktstatus": "ActiveState",
    "full_adress": "Solvang 12, 5521 Haugesund",
    "gatenavn": "Solvang",
    "husnr": "12",
    "husbokstav": "",
    "poststed": "Haugesund",
    "postnr": "5521"
  }
]

Feilmeldinger

  • {"error": "Unauthorized"} – Manglende eller ugyldig token
  • {"message": "No match"} – Ingen treff
  • {"message": "Too many hits. Please narrow your search."} – Over 50 treff

Forklaring: leveransepunktstatus

Statuskode Beskrivelse
ActiveStateTilkoblet, aktivt leveransepunkt/kunde
ConnectedStateTilkoblet, inaktivt leveransepunkt/kunde. Har tidligere vært kunde her.
DisconnectedStateNedkoblet. Installasjon med montør må til.
ToConsiderationIkke installert, men vi kan levere. Installasjon med montør må til.
UnderConstructionIkke installert, men vi kan levere. Installasjon med montør må til.
CancelledWorkIkke installert, men vi kan levere. Installasjon med montør må til.

Opprett hentekode

Dette endepunktet brukes til å opprette en hentekode og sende SMS til kunden som skal hente utstyr i butikk.

URL

POST https://api.hkbb.no/store-pickup/create/

Autentisering

Bruk Authorization: Bearer <token> i header.

Body-parametre (JSON)

FeltBeskrivelseEksempelObligatorisk
kundenavnNavn på kundenOla NordmannJa
kundenummerKundens ID123456Ja
mobilMobilnummer til kunde98237182Ja
partnerNavn på partnerHaugaland KraftJa
ticket_typeType henvendelsestb_new_1Ja
info2butikkValgfri beskjed til butikkSendes med retur-dekoderNei

Eksempel (cURL)

curl -X POST https://api.hkbb.no/store-pickup/create/ \
-H "Authorization: Bearer <ditt-token>" \
-H "Content-Type: application/json" \
-d '{
  "kundenavn": "Ola Nordmann",
  "kundenummer": "123456",
  "mobil": "98237182",
  "partner": "Haugaland Kraft",
  "ticket_type": "stb_new_1",
  "info2butikk": "Dekoder og fjernkontroll"
}'

Eksempel på respons (JSON)

{
  "success": true,
  "hentekode": "8XK2FZ",
  "message": "Hentekode opprettet og SMS sendt"
}

SMS som sendes

Hei Ola Nordmann. Du kan nå gå til valgfritt Kontaktpunkt for å få hjelp.
Oversikt her: https://bit.ly/3dEItuX
Din hentekode er 8XK2FZ.
Ha en fin dag! Hilsen Haugaland Kraft
            

Feilmeldinger

  • {"error": "Unauthorized"} – Manglende eller ugyldig token
  • {"error": "Missing required fields"} – Obligatoriske felt mangler
  • {"error": "Database error"} – Klarte ikke lagre til databasen

Sikkerhet & logging

Kontakt