Gå til innhold

Connect API — interaktiv referanse

Full OpenAPI 3.0-spesifikasjon for ePortal Integration API. Interaktiv dokumentasjon som genereres fra produksjons-API-et https://connect.elportal.no. Du kan utforske endepunkter, se request/response-skjema og prøve kall direkte herfra (etter at du har autentisert).

ePortal Integration API tilbyr to API-versjoner samtidig med ulike autentiseringsmetoder. Bruk v2 til ny integrasjon — v1 er beholdt for eksisterende koblinger.

Versjon Autentisering Status
v2 OAuth 2.0 (Azure AD client credentials) Anbefalt for nye integrasjoner
v1 API-nøkkel via X-API-Key-header Stabil, vedlikeholdes — ingen nye features

Begge versjoner eksponerer i praksis samme funksjonsområder (Accounting, Actor, Configuration, Deal, NisAssets, Product, ProjectTask, Time, WorkOrder), totalt drøyt 80 endepunkter per versjon. For nøyaktig liste — bruk Swagger-utforskeren under, eller hent swagger.json direkte.

Sandkasse vs produksjon: Embedden under peker til produksjons-endepunktet. Ikke prøv kall direkte fra denne siden hvis du ikke har sandkasse-credentials — du risikerer å skrive til reelle kundedata.

Autentisering: Azure AD client credentials. Du trenger:

  • Tenant-ID (integrator-tenant)
  • Client-ID (API-klient)
  • Client secret

Hent token fra Azure AD og bruk som Authorization: Bearer <token> i Swagger UI eller dine egne kall.

  • Token-endepunkt: https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/token
  • Scope: api://{api-client-id}/.default
  • Grant type: client_credentials

Verifisert i ConfigureSwaggerOptions.cs:59 og Program.cs:125.

Autentisering: Klikk Authorize øverst, lim inn API-nøkkel i X-API-Key-feltet og klikk Authorize. Nøkkelen brukes kun lokalt i nettleseren — den lagres ikke i håndboken.

Header-navnet og valideringen håndteres i ApiKeyMiddleware.cs.

Legacy — ingen nye features

v1 vedlikeholdes for kontraktsstabilitet med eksisterende integrasjoner, men får ingen nye endepunkter. Migrér til v2 ved første anledning.

Slik prøver du et kall fra Swagger UI

  1. Velg riktig fane (v2 eller v1) over.
  2. Klikk Authorize øverst i Swagger UI.
  3. Lim inn credentials (token for v2, API-nøkkel for v1) og klikk Authorize.
  4. Bla til ønsket endepunkt, klikk Try it out, fyll inn parametere, og Execute.
  5. Bekreft at responsen er som forventet før du går videre til egen integrasjonskode.

Hvis Swagger-utforskeren ikke lastes

Symptom Sannsynlig årsak Løsning
Tom boks over CORS blokkerer JSON-fetch Åpne https://connect.elportal.no/swagger direkte i ny fane
"Failed to fetch" Nettverk eller VPN-krav Sjekk at du har nettverkstilgang til Konti-domener
Lang lasting Stor spec — drøyt 80 endepunkter per versjon Vent 5–10 sekunder; Swagger UI lazy-loader

Postman-kolleksjon

For v2 finnes en ferdig Postman-kolleksjon: ePortal_Integration_API_v2_OAuth.postman_collection.json (referert i ConfigureSwaggerOptions.cs:154).

Relaterte sider