Uniweb Partner API

Deler av den opprinnelige API-dokumentasjonen refererer til eldre webhotellplattformer (tws). Disse funksjonene er ikke dokumentert for dagens plattform og er derfor utelatt fra denne guiden. Dokumentasjon for webhotelladministrasjon via API vil bli oppdatert når funksjonaliteten er gjennomgått og verifisert.

Oversikt

Uniwebs Partner API gjør det mulig å integrere egne systemer og arbeidsprosesser mot Uniweb-plattformen.

API-et er spesielt utviklet for partnere som ønsker å automatisere administrasjon av kunder, domener, webhotell, e-post, fakturadata og andre tjenester.

Typiske bruksområder er:

Synkronisering av kunder mellom egne systemer og Uniweb
Henting av domene- og abonnementslister
Integrasjon mot ERP- og fakturasystemer
Automatisk provisjonering av tjenester
Opprettelse av domener, webhotell og e-postkontor

Forutsetninger

Partner API er tilgjengelig for Uniweb-partnere.

API-et benytter autensiering via samme brukeradgang som kontrollpanelet.

Base URL

https://www.uniweb.no/api/partner

Alle endepunkter i denne guiden er relative til denne URL-en.

Autensiering

API-et benytter informasjonskapslene (cookies) session og grant for autensiering.

For å hente disse:

Logg inn på partnerkonto via uniweb.no/controlpanel
Åpne nettleserens utviklerverktøy (F12)
Finne en forespørsel mot Uniweb-plattformen
Kopier verdiene for:
- session
- grant

Disse må sendes med i alle API-kall.

Eksempel:

Cookie: session=aabbcc, grant=xxyyzz

Ved manglende eller ugyldig autensiering returneres:

HTTP 401 Unauthorized

Hente tjenester og abonnementer

Liste alle abonnementer:

GET /subscriptions

Abonnementer omfatter blant annet:

Domenenavn
Webhotell
E-post
SSL sertifikater
Tilleggstjenester

Eksempel:

{
  "id": 1234,
  "username": "eksempel.no",
  "renew": true,
  "created": "2024-01-01",
  "period": {
    "from": "2024-01-01",
    "to": "2025-01-01"
  }
}

Forklaring av felter:

Felt	Beskrivelse
username	Domenenavn eller brukernavn på tjeneste
renew true/false	Automatisk fornyelse på/av
period.to	Fornyelse-/utløpsdato
created	Opprettelsesdato

Hente abonnementer for én kunde

GET /subscriptions/customer/{customerId}

Hente domeneinformasjon

Domener hentes gjennom abonnementsendepunktene.

Et domeneabonnement vil blant annet inneholde:

Domenenavn
Opprettelsesdato
Fornyelses-/utløpsdato
Fornyelsesstatus

Dette gjør API-et godt egnet til:

Domeneoversikter
Varsling om fornyelse eller utløp
Integrasjon mot kundeportaler

Hente produkter

Liste produkter

GET /products

Eksempel på svar:

{
  "id": 102091,
  "text": ".no Domene",
  "period": "1Y",
  "type": "dns"
}

Typiske bruksområder:

Oppslag av produkt-IDer
Synkronisering av produktkatalog til eget system
Opprettelse av nye tjenester via API
Kontroll av faktura- og abonnementsdata

Filtrere produkter

Kun domener:

GET /products?code=dns

Flere produktkategorier:

GET /products?code=dns,tws

Merk at enkelte produktkoder i API-dokumentasjonen kan referere til eldre plattformer og tjenester som ikke lenger tilbys.

Ordre og faktura

API-et kan brukes til å hente informasjon om ordre, fakturaer og ordrelinjer.

Hent alle ordre

GET /orders

Eksempel på svar:

{
  "id": 2003004,
  "invoiceNo": "012345678",
  "invoiceDate": "2026-01-01",
  "invoiceDue": "2026-01-15",
  "invoiceSum": 1000.00,
  "paid": 0.00
}

Hent kun nye fakturaer

Ved integrasjon mot økonomi- eller ERP-systemer kan man hente fakturaer som er opprettet etter sist kjente fakturanummer.

GET /orders?latestSeenInvoiceNo=123456

Hent én ordre

GET /orders/{id}

Hent ordrelinjer

GET /orders/{id}/orderlines

Eksempel på svar:

{
  "type": "Renew",
  "text": ".no Domene",
  "price": 139.30,
  "qty": 1
}

Ordrelinjer inneholder informasjon om blant annet:

Produkt
Fakturert periode
Pris
Antall
Dato for opprettelse
Dato for utløp/fornyelse

Prislister

Partnere med egendefinerte prislister kan hente disse via API-et.

Hent alle prislister

GET /pricelists

Eksempel på svar:

{
  "id": 1234,
  "name": "Standard partnerprisliste"
}

Hent innhold i prisliste

GET /pricelists/{id}

Eksempel på svar:

{
  "product": 102091,
  "rc": 139.30,
  "otc": 0,
  "forsale": true
}

Forklaring av felter:

Felt	Beskrivelse
product	Produkt-ID
rc	Løpende pris (renewal cost)
otc	Oppstartspris (one time cost)
forsale	Om produktet kan bestilles

E-post

API-et gir begrenset støtte for opprettelse av e-posttjenester.

Antall e-postkontoer

GET /email/count

Eksempel på svar:

{
  "count": 1234
}

Opprett e-postkonto

POST /mail/accounts

Eksempel:

{
  "customer": 1234,
  "domain": "eksempel.no",
  "localpart": "ola",
  "name": "Ola Nordmann"
}

Dette oppretter e-postadressen ola@eksempel.no, for kundenummer 1234 Ola Nordmann.

Opprett e-postpakke

POST /mail/bundle

Eksempel:

{
  "customer": 1234,
  "domainName": "eksempel.no",
  "productType": "Essential"
}

Tilgjengelige produkttyper:

Essential
Unlimited

Vanlige bruksområder

Kunde- og CRM-synkronisering

GET /customers
GET /subscriptions

Henter kunde- og abonnementsinformasjon til egne systemer.

Domeneoversikter

GET /subscriptions

Gir oversikt over domener, fornyelsesstatus og abonnementsperiode.

Fakturaintegrasjon

GET /orders
GET /orders?latestSeenInvoiceNo=xxxxx

Brukes til å hente nye fakturaer og ordredata til økonomisystemer.

Produkt- og prisintegrasjon

GET /products
GET /pricelists

Gir tilgang til produktkatalog og egne partnerpriser.

Begrensninger

Følgende er viktig å være oppmerksom på:

API-et benytter cookie-basert autentisering (session og grant).
Ikke alle søkeparametere for kunde- og ordresøk er dokumentert.
Enkelte funksjoner i den opprinnelige API-dokumentasjonen refererer til eldre plattformer og tjenester.
Dokumentasjon for webhotelladministrasjon på dagens one-web-plattform er ikke tilgjengelig per i dag og er derfor utelatt fra denne guiden.
DNS-administrasjon via API støttes ikke lenger og er derfor ikke dokumentert.

Var denne artikkelen nyttig?

Oversikt

Forutsetninger

Base URL

Autensiering

Hente tjenester og abonnementer

Hente domeneinformasjon

Hente produkter

Ordre og faktura

Prislister

E-post

Vanlige bruksområder

Begrensninger

Fant du ikke det du trengte?