API-et for rapportdata

API-et for rapportdata gir radene i en rapport i ABMS som JSON, til Power BI eller et annet verktøy. Det har to kall: ett for å hente et token, og ett for å hente en rapport. Begge bruker den samme nettadressen som ABMS hos dere, fulgt av stien nedenfor. Denne siden er for IT-avdelingen; hvordan dere setter det opp steg for steg, står i Hent rapportdata inn i Power BI eller et annet verktøy.

1. Hent et token

Punkt	Verdi
Metode og sti	`POST /api/authenticate`
Parametere	`email`: e-postadressen til API-brukeren. `password`: passordet. Send begge i selve forespørselen.
Svar når det virker	`{"auth_token": "<token>"}`
Svar når det feiler	Status 401 med teksten «invalid credentials».
Gyldig i	72 timer fra det ble utstedt.

Brukeren må logge inn med passord. En bruker som logger inn med Office 365, kan ikke få et token.

2. Send tokenet

Hvert kall til API-et trenger denne HTTP-headeren:

Authorization: Bearer <token>

Uten token, eller med et utløpt eller feil token, er svaret status 401 med {"error": "Not Authorized"}. Hent et nytt token og prøv igjen.

3. Hent en rapport

Punkt	Verdi
Metode og sti	`GET /api/v1/<kunde-ID>/documents/reports/<rapport-ID>`
`<kunde-ID>`	Kunde-ID-en til virksomheten i ABMS. API-brukeren må ha tilgang til den virksomheten; ellers er svaret status 401.
`<rapport-ID>`	ID-en til rapporten i ABMS.

Hvilke rettigheter API-brukeren trenger for å lese rapporten: spør Antenor support.

Parametere

Parameter	Hva den gjør	Påkrevd
`count`	Antall rader per side.	Ja i praksis: uten den kommer det ingen rader.
`page`	Hvilken side med rader som skal hentes.	Nei
`language`	Språket i svaret.	Nei

Tillatte verdier og standardverdier for page og language får dere hos Antenor support. API-et godtar flere valgfrie parametere (sort, reverse, search, archived, from, to). Kontakt Antenor support før dere bygger på dem.

Eksempel: GET /api/v1/<kunde-ID>/documents/reports/<rapport-ID>?count=500&page=1

Svar

{
  "documents": [
    { "<kolonnetittel>": <verdi>, "<kolonnetittel>": <verdi>, ..., <lenke til dokumentet> }
  ],
  "documents_count": <antall>
}

documents har én oppføring per dokument på siden som ble hentet. Hver oppføring har én verdi per kolonne i rapporten, med kolonnetittelen som navn, og en lenke til dokumentet.
documents_count er det samlede antallet dokumenter i rapporten.
Kolonnene er de lagrede kolonnene i rapporten. Radene følger dokumenttypene nye, pågående og fullførte i rapporten, hovedfilteret i rapporten og eventuelle personlige filtre som API-brukeren har satt på rapporten i ABMS. Arkiverte dokumenter utelates med mindre archived=1 sendes; se API-et for rapportdata: parametere, rader og verdier i detalj. Når noen endrer kolonnene eller filteret i rapporten på fanen Innstillinger, endres også svaret; se Fanen Innstillinger i en rapport.

Neste steg

Hent rapportdata inn i Power BI eller et annet verktøy