Hent innboks

Hent innboks endepunktet leverer informasjon tilknyttet dokumentene som ligger i Digipost-kassen til en virksomhet. Interaksjon med en virksomhets Digipost-kasse innebærer også sannsynligvis å hente ned de faktiske dokumentene (innholdet) og å slette dem i etterkant (om ønsket).

Alle endepunktene tilknyttet interaksjon med virksomhetens Digipost-kasse bygger på de etablerte sikkerhetsmekanismene i Digipost APIet. Som ved sending av dokumenter i Digipost, kreves en registrert virksomhetskonto i Digipost for å kunne hente ned digital post fra virksomhetens Digipost-kasse. Dette kan gjøres som en behandler på vegne av en avsender eller på vegne av seg selv.

Get inbox provides a list of all documents that are presently in the organisation's inbox. Interacting with an organisation's inbox normally also includes downloading the actual content of the documents and/or deleting the documents after they have been downloaded (not mandatory).

All endpoints tied to interacting with an organisation's inbox use the same security mechanisms that the overall Digipost API uses. As with sending documents, the inbox endpoints also require a registered Digipost organisation account. The organisation can either send as a broker or on behalf of itself.

Endepunkt

Endpoint

https://api.digipost.no/{sender-id}/inbox

Verb

http get

Request

https://api.digipost.no/{sender-id}/inbox?offset=0&limit=100

Response

<inbox>
  <document>
    <id>1234</id>
    <subject>Innkalling til årsmøte</subject>
    <sender>Posten Bring As</sender>
    <delivery-time>2017-05-23T09:30:10+02:00</delivery-time>
    <first-accessed>2017-02-14T08:25:00+01:00</first-accessed>
    <authentication-level>TWO FACTOR</authentication-level>
    <content-type>application/pdf</content-type>
    <content-uri>/1000/inbox/1234/content</content-uri>
    <delete-uri>/1000/inbox/1234</delete-uri>
    <attachment>
      <id>2345</id>
      <subject>Referat fra fjorårets årsmøte</subject>
      <sender>Posten Bring As</sender>
      <delivery-time>2017-05-23T09:30:10+02:00</delivery-time>
      <first-accessed>2017-02-14T08:25:00+01:00</first-accessed>
      <authentication-level>TWO FACTOR</authentication-level>
      <content-type>application/xml</content-type>
      <content-uri>/1000/inbox/2345/content</content-uri>
    </attachment>
  </document>
</inbox>

Kommentarer

Additional comments

• Antall dokumenter (bare metadata) kan settes ved bruk av offset og limit request parametere. Rekkefølgen på dokumentene som returneres må ikke betraktes som IDer på dokumentene, dvs. to fortløpende requests med offset = 0 og limit = 100 vil ikke nødvendigvis returnere det samme resultatet. Klienten står ansvarlig for å holde orden på dokumentene ved bruk av "id" elementet. "first-accessed" elementet kan benyttes til å sjekke om dokumentet er tidligere aksessert.
• "authentication-level" tilsier nivået på autentisering som ble benyttet når dokumentet ble opprinnelig sendt til virksomheten. Det betyr at Digipost vil kreve dette autentiseringsnivået ved åpning av dokumentet på digipost.no/bedrift. Det er opp til systemet som henter ned digital post fra virksomhetens Digipost-kasse om dette autentiseringsnivået videreføres i det integrerte systemet.
• Responsen inkluderer URIer som kan kalles for å enten laste ned dokumentet (det faktiske innholdet) eller slette dokumentet.

• The number of documents to be returned (only metadata) can be set by using the offset and limit request parameters. The order of the returned dokuments should not be used as IDs for the documents. Two consecutive requests with offset = 0 and limit = 100 may return a different list of documents. The client can use the actual document id to keep track of what has been accessed (or downloaded). The "first-access" element can be used to check if this is the first time a document has been accessed.
• The authentication-level element defines what level was used when the document was originally sent to the organisation. Digipost will require the defined authentication level if the document is accessed at digipost.no/bedrift, however it is up to the system which is retrieving the documents which authentication level is to be used in that system.
• The response includes URIs that can be requested to either download or delete the actual document (content).