1. Hjem
  2. Kunnskapsbase
  3. Peppol
  4. Slik bruker du Peppol API: trinnvis veiledning
  1. Hjem
  2. Kunnskapsbase
  3. EDI
  4. Slik bruker du Peppol API: trinnvis veiledning
  1. Hjem
  2. Kunnskapsbase
  3. Brukerveiledninger
  4. Slik bruker du Peppol API: trinnvis veiledning
  1. Hjem
  2. Kunnskapsbase
  3. Integrasjoner
  4. Slik bruker du Peppol API: trinnvis veiledning

Slik bruker du Peppol API: trinnvis veiledning

Slik bruker du Peppol API: trinnvis veiledning

Peppol API

Enten du er en liten bedrift, en stor Bedrift , eller en programvareleverandør, gir Qvalias API deg én enkelt, standardbasert måte å integrere med Peppol-nettverket på, med valgfri støtte for ytterligere EDI-flyter, intelligent dokumentbehandling og databerikelse.

Gjennom tjenesten Fakturering API kan du jobbe med fakturarelaterte Peppol-meldinger som BIS Billing (faktura), BIS Billing Kreditnota (kreditnota), BIS-selvfaktura, BIS-selvfaktureringskreditnota og BIS Invoice Response , og, når det er nødvendig, komplettere dem med meldingsnivårespons for tekniske bekreftelser knyttet til fakturaer og andre Peppol-meldinger.

API-et kan:

  • Hjelp et lite selskap med å raskt sende Peppol-fakturaer
  • Støtt en stor Bedrift med strukturerte meldingsflyter med høyt volum
  • Kraftfull faktureringsprogramvare og ERP-er som trenger tilkobling til flere leietakere for mange kunder

I denne veiledningen lærer du hvordan du:

  • Sett opp Qvalias transaksjons-API som ditt Peppol- og EDI-knutepunkt
  • Bytt din første Peppol-faktura via API
  • Utvid utover fakturaer til bestillinger, kataloger og mer
  • Muliggjør skalerbare modeller for flere leietakere for programvareleverandører
  • Legg til avansert KI -drevne datafunksjoner for databerikelse og PDF-uttrekking

Oversikt: API for Peppol og EDI

Peppol API tilbyr et enhetlig grensesnitt for elektroniske forretningsmeldinger over Peppol og EDI. Det er bygget for å støtte kjernescenarier som:

  • Fakturaer og kreditnotaer
  • Innkjøpsordrer og ordresvar
  • Ordreendringer og kanselleringer
  • Kataloger og vareoppdateringer
  • Forsendelsesråd
  • Svar på meldingsnivå og statusoppdateringer

Et felles designprinsipp brukes på tvers av alle endepunkter:

  • REST-baserte HTTP-endepunkter
  • Støtte for både JSON og XML
  • UBL 2.1 som underliggende datamodell
  • Feilhåndtering ved bruk av standard HTTP-statuskoder

For deg betyr dette at du kan tenke i forretningsmeldinger i stedet for nettverk og protokoller. Du oppretter gyldige UBL-baserte dokumenter; Qvalia håndterer Peppol- og EDI-laget i bakgrunnen.

Komme i gang: forutsetninger og oppsett

For å komme i gang med Qvalias Peppol API kreves det bare noen få grunnleggende prinsipper:

Qvalia-konto
Organisasjonen din er registrert som Qvalia-kunde. Du mottar et kontoregistreringsnummer som unikt identifiserer kontoen din i alle transaksjonsanrop.

API-nøkkel
Autentisering håndteres via en API-nøkkel, med separate nøkler for test- og produksjonsmiljøer. Alle anrop gjøres over HTTPS med moderne TLS.

Kontoregistreringsnummer i URL-banen
Transaksjonskall inkluderer kontoregistreringsnummeret ditt i banen. For eksempel:

POST /transaksjon/{kontoreg.nr.}/fakturaer/utgående
POST /transaction/{accountRegNo}/invoices/outgoing

Formatvalg: JSON eller XML
Du kan velge JSON eller XML via standard HTTP-overskrifter (Content-Type og Accept). JSON er standard hvis det ikke gjøres noe eksplisitt valg.

Når disse elementene er på plass, er du klar til å begynne å teste Peppol-trafikk med Qvalia.

Steg for steg: integrering av din første Peppol-fakturaflyt (send og motta)

Denne delen går gjennom en typisk første integrasjon mellom systemet ditt og Qvalias transaksjons-API, som dekker både sending og mottak av Peppol-fakturaer.

Trinn 1: Start i sandkassen

Begynn med å integrere mot sandkassemiljøet:

  • Basis-URL (eksempel): https://api-qa.qvalia.com
  • Samme autentiseringsmodell, endepunkter og struktur som produksjon

Dette lar deg bygge og teste uten å påvirke reelle kunder eller økonomiske strømmer.

Trinn 2: Bruk API-nøkkelen og kontoregistreringsnummeret ditt

I konfigurasjonen din, lagre:

  • API-nøkkelen din (for sandkassen)
  • Ditt kontoregisternummer

Hver forespørsel bør inneholde:

  • Autorisasjonshode med API-nøkkelen
  • kontoRegistreringsnr. i endepunktsbanen, for eksempel:
    Utgående fakturaer: /transaction/{accountRegNo}/invoices/outgoing
    Innkommende fakturaer (pull): /transaction/{accountRegNo}/invoices/incoming

Trinn 3: Velg JSON eller XML (UBL-basert)

Alle transaksjoner bruker UBL 2.1 som underliggende standard.

Du kan enten:

  • Generer UBL 2.1 XML , eller
  • Bruk UBL JSON- representasjonen, og tilordne den samme strukturen til JSON-felt

Overskrifter styrer formatet:

JSON (standard)

Innholdstype: application/jsonGodta: application/json
Content-Type: application/jsonAccept: application/json

XML

Innholdstype: application/xmlGodta: application/xml
Content-Type: application/xmlAccept: application/xml

Denne fleksibiliteten lar deg integrere Peppol API i både JSON-first- og XML-first-miljøer.

Trinn 4: Tilordne fakturaen din til UBL

Deretter tilordner du den interne fakturamodellen din til UBL-elementer. Både UBL JSON og UBL XML er tilgjengelige.

  • Topptekstinformasjon (faktura, utstedelsesdato, fakturatypekode)
  • Parter (RegnskapsleverandørParty, RegnskapskundeParty)
  • Totaler (TaxTotal, LegalMonetaryTotal)
  • Linjer (Fakturalinje, Vare, Pris, Avgiftskategori)

Målet er å sikre at:

  • Alle obligatoriske felt er til stede
  • Verdiene samsvarer med den relevante Peppol-profilen (for eksempel BIS Billing )
  • Dine egne forretningskrav (referanser, kostnadssteder, prosjektkoder) er oppfylt

Deretter serialiserer du dette enten som JSON eller XML, avhengig av formatvalget. For innkommende fakturaer bruker du den samme UBL-strukturen når du leser, validerer og tilordner data fra Qvalia til den interne modellen din.

Trinn 5a: Send en utgående Peppol-faktura

Trinn 5.1: Send en utgående Peppol-faktura

Med den utgående nyttelasten klar, eksempel på endepunkt:

POST https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing
POST https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/outgoing

Inkludere:

  • Autorisasjonsoverskrift med API-nøkkelen din
  • Riktig Content-Type-overskrift (JSON eller XML)
  • Den UBL-baserte fakturanylasten i forespørselsteksten

Qvalia validerer fakturaen og ruter den via Peppol-nettverket eller EDI/ VAN , og returnerer et svar med identifikatorer og status.

Trinn 5.2: Motta innkommende Peppol-fakturaer

For å hente innkommende fakturaer fra Qvalia via API, gjør du vanligvis følgende:

Kall det innkommende endepunktet, for eksempel:

GET https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming
GET https://api-qa.qvalia.com/transaction/{accountRegNo}/invoices/incoming

Valgfritt kan du:

  • Filtrer eller sidesøk resultater (avhengig av oppsettet ditt)
  • Bruk «lese»-endepunkter for å skille mellom nye og allerede behandlede fakturaer

Den returnerte UBL JSON- eller XML-filen blir deretter tilordnet den interne datamodellen din for publisering, godkjenning eller videre behandling.

Trinn 6: Håndter overvåking, responser og feil

Transaksjons-API-et bruker forutsigbare HTTP-statuskoder som du kan tilordne til logger, overvåking og brukermeldinger. Typiske mønstre:

  • 200 OK – Forespørselen var vellykket, og dataene returneres
  • 204 Intet innhold – Vellykket forespørsel, ingen tekst tilgjengelig
  • 400 / 422 – Ugyldige data eller skjema; juster nyttelasten eller parsingen
  • 401/403 – Problemer med autentisering eller tillatelser
  • 404 – Ressurs ikke funnet (ofte et problem med sti eller ID)
  • 409 – Konflikt, for eksempel duplikater
  • 429 – Hastighetsgrensen er nådd; senk forespørslene dine
  • 500 – Intern feil; prøv på nytt eller varsle kundestøtte hvis problemet vedvarer

De samme mønstrene gjelder enten du sender eller mottar fakturaer.

Bruk transaksjonsloggen for driftsoppfølging

I tillegg til API-svarene kan du alltid logge inn på Qvalia og se gjennom aktiviteten i transaksjonsloggen. Dette gir deg en brukergrensesnittbasert oversikt over hva som skjer i integrasjonen din, inkludert for eksempel:

  • Sendte og mottok fakturaer
  • Status for individuelle transaksjoner
  • Feildetaljer og tilbakemeldinger om validering
  • Tidsstempler på teknisk og forretningsnivå

Transaksjonsloggen er nyttig for:

  • Førstelinjesupport og driftsteam som ikke jobber direkte med API-et
  • Feilsøking av spesifikke problemer rapportert av kunder eller interne brukere
  • Verifisere at endringer i integrasjonen din oppfører seg som forventet i produksjon

Sammen gir HTTP-statuskodene og transaksjonsloggen et komplett bilde: systemet ditt kan reagere programmatisk på svar, mens teamet ditt kan undersøke og følge opp direkte i Qvalia ved behov.

Utover fakturaer: Utvid bruksscenariet for Peppol API

Når du har fakturaer på plass, er det enkelt å utvide integrasjonen til en komplett Peppol-meldingsportefølje.

Typiske utvidelser inkluderer:
Bestillinger . Motta og send strukturerte bestillinger elektronisk
Ordresvar og endringer. Bekreft, endre eller avbryt bestillinger
Kataloger . Vedlikehold produkt- og prisinformasjon i elektroniske kataloger
Forsendelsesråd . Kommuniser forsendelsesinformasjon
Svar på meldingsnivå . Spor bekreftelser på teknisk nivå og forretningsnivå.

Fordi alt dette bruker samme API-design, autentiseringsmodell og UBL 2.1-datamodell, trenger du ikke separate prosjekter eller gatewayer for hver dokumenttype. Du muliggjør nye brukstilfeller etter hvert som bedriften din eller kundenes krav utvikler seg.

Det er her løftet om «ett Peppol API uansett behov» blir konkret: den samme integrasjonen betjener små leverandører, store bedrifter og komplekse plattformscenarioer.

Partner-API for faktureringsprogramvare og ERP-er

Hvis du er en programvareleverandør – som driver en faktureringsplattform, ERP, regnskapsløsning eller integrasjonsplattform – er kravene dine litt annerledes. Med Qvalias Partner API kan du sette opp en flerleietakerkonfigurasjon for utveksling av meldinger for sluttbrukere, inkludert administrasjon av Peppol ID registreringer.

Partner-API-et for Peppol er nødvendig hvis du trenger å:

  • Betjen mange sluttkunder fra én plattform
  • Hold et klart skille mellom hver kundes data og transaksjoner
  • Unngå å bruke din egen Peppol aksesspunkt eller EDI-gateway

Qvalias partnerorienterte modell er spesielt utviklet for dette formålet.

Slik fungerer partneroppsettet

  • Bedriften din blir registrert som partner og mottar en partneridentifikator.
  • Du kan velge mellom to metoder for å håndtere sluttbrukermeldinger, 1) en samlet delt brukerkonto, eller 2) individuelle Qvalia-kontoer for hver sluttbruker, hver med sitt eget kontoregisternr.
  • API-kall inkluderer både partnerkonteksten din og den spesifikke kundekontoen, slik at du kan sende og motta meldinger på deres vegne.

Eksempel: Partnerimplementering

Ombordstigning

  • Organisasjonen din mottar partnerlegitimasjon og konfigurasjon, inkludert et partnerregistreringsnummer og en API-nøkkel.
  • Du setter opp én enkelt integrasjon mot Qvalias API ved hjelp av /partner/{partnerRegNo} prefiks for alle partneromfattede kall.

Kundeinnføring i produktet ditt

  • Når en kunde aktiverer Peppol/e-fakturering i brukergrensesnittet ditt, opprettes eller kobles en Qvalia-konto for den kunden.
  • Du lagrer kundens kontonummer sammen med din egen kunde-ID, slik at du kan adressere transaksjoner per kunde.

Sende og motta transaksjoner per kunde

Applikasjonen din genererer eller bruker UBL-nyttelaster (fakturaer, bestillinger osv.) på samme måte som med standard Transaction API. For å sende eller motta transaksjoner på vegne av en bestemt kunde, kaller du Transaction API gjennom det partnerprefikserte URI-mønsteret:

/partner/{partnerRegnr.}/transaksjon/{kontoRegnr.}/{meldingstype}/{retning}
/partner/{partnerRegNo}/transaction/{accountRegNo}/{message-type}/{direction}

For eksempel:

  • Sende utgående faktura: /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/outgoing (STOLPE)
  • Henting av innkommende fakturaer: /partner/{partnerRegNo}/transaction/{accountRegNo}/invoices/incoming (BLI)
  • Bruk av read varianter der det er aktuelt ved å legge til read i stien.

Qvalia ruter og mottar meldinger som om de ble sendt eller mottatt direkte av kunden, med full sporbarhet per konto.

Fordeler for programvareleverandører

  • Én teknisk integrasjon, mange kunder, ved bruk av en konsistent partner- og kontomodell.
  • Du trenger ikke å drifte og vedlikeholde din egen Peppol- eller EDI-basisnettside.
  • Enkel skalering til nye markeder, mandater og meldingstyper ved å gjenbruke det samme partnerintegrasjonsmønsteret.

Ytterligere funksjonalitet: KI agentisk berikelse

I tillegg til transport og tilkobling tilbyr Qvalia også Enrichment API , som kan berike transaksjoner med linjeelementklassifisering, behandling før og etter transaksjoner og mer, og kan trekke ut og transformere PDF-dokumenter til rike, strukturerte og validerte data med minimal innsats.

Berikelses-API-et er utformet som en asynkron tjeneste:

  • Du sender inn en fakturafil (f.eks. PDF eller XML) via API-et.
  • Du mottar en pollingId i svaret.
  • Du avstemmer statusen din til berikelsen er fullført.
  • Du henter et strukturert JSON-resultat med utvidet informasjon.

Dette resultatet kan inkludere:

  • Parset fakturainnhold hentet fra originalfilen
  • Validering mot Peppol eller andre forretningsregler
  • Normaliserte felt egnet for analyse, automatisering og KI arbeidsflyter

Implementeringsmønster

En typisk integrasjon ser slik ut:

Send inn en faktura for berikelse
Ring et endepunkt, legg ved fakturafilen og eventuelle relevante metadata, og
Lagre den returnerte pollingId-en.

POST /berikelse/{kontoRegnr.}/faktura
POST /enrichment/{accountRegNo}/invoice

Avstemning for fullføring
Kall med trygge intervaller. Under behandlingen bekrefter API-et at jobben fortsatt kjører. Når den er ferdig, returnerer den en status og lenker til berikelsesresultatet.

GET /berikelse/{kontoRegnr.}/{avstemnings-ID}
GET /enrichment/{accountRegNo}/{pollingId}

Hent spesifikke berikelsestyper
Ring for å få et bestemt berikelsesresultat – for eksempel detaljerte fakturadata eller Peppol-valideringsresultater. Mat dette inn i regnskapsmotoren, analysestakken eller automatiseringslogikken din.

GET /berikelse/{kontoRegistreringsnr.}/{avstemnings-ID}/{berikelsestype}
GET /enrichment/{accountRegNo}/{pollingId}/{enrichmentType}

Bruksområder

  • Små bedrifter
    Kan dra nytte av Bedrift intelligent dokumentbehandling på alle nivåer; rene, strukturerte data uten å investere i komplekse OCR- eller valideringsverktøy.
  • Large bedrifter
    Kan standardisere faktura- og dokumentdata på tvers av enheter, systemer og geografiske områder, og muliggjøre bedre datakontroll, analyse og regnskapsautomatisering.
  • Programvareleverandører og partnere
    Kan bygge inn avanserte berikelsesfunksjoner direkte i produktene sine, uten å bygge sine egne parse- og regelmotorer.

I alle tilfeller er tilgangen til denne teknologien enkel: samme konto- og sikkerhetsmodell som Transaction API, og et lite sett med veldefinerte endepunkter.

Peppol API-tilgang for alle bedrifter

Qvalias API er bygget for å gi deg en forenklet, skalerbar aksesspunkt til Peppol-nettverket , uavhengig av bedriftstype:

  • En liten bedrift som trenger å utveksle kompatible e-fakturaer
  • En stor Bedrift håndtering av store volumsflyter med flere enheter
  • En programvareleverandør som tilbyr fakturering, ERP eller finansløsninger til mange kunder

Neste steg er enkelt: koble til sandkassen, send din første testfaktura, og begynn å planlegge hvordan Peppol, EDI og berikelse kan bli en innebygd del av driften eller produktet ditt – i stedet for et separat, komplekst prosjekt.

Var denne artikkelen nyttig?

Relaterte artikler