Adgang til Responza API

Information

Responza giver jer mulighed for, at hente systemets data via API kald. I følgende eksempel kan I se hvordan det gøres. Vi bruger feedbacks som eksempel.

 

Request

Responzas API findes på følgende URL: https://api.spitzeco.dk.

Når man ønsker at hente alle åbne feedbacks sendes der et GET request til følgende URL:


https://api.spitzeco.dk/feedbacks

 

Request Header

For at denne request bliver accepteret, skal der angives en abonnementsnøgle i request header.

Denne bliver sat i følgende format:


Ocp-Apim-Subscription-Key: [abonnementsnøgle]

 

Nøglen sender vi til jer. Det er vigtigt, at nøglen beskyttes godt. Bliver den kompromitteret så kontakt os på support@spitzeco.dk. Vi vil derefter oprette en ny nøgle til jer. 
 

Query parameter

Det er muligt at sende diverse query parametre med sit request. For feedbacks kan det være følgende.

  • Et request med https://api.spitzeco.dk/feedbacks giver alle åbne feedbacks
  • Et request med følgende query parameter: https://api.spitzeco.dk/feedbacks?status=closed returnerer alle lukkede feedbacks

 

Output

API kaldet vil svare med en liste af objekter i følgende format. Hvert objekt repræsenterer et feedback med alle relevante informationer. 

  {
    "id": "84fa9914-556e-48b9-890e-37d53ebfda45",
    "author": "Test",
    "email": "test@test.dk",
    "area": {
      "id": "bd4362a6-f826-46c4-a573-f689b70bbd6b",
      "name": "Dev Kb",
      "mailbox": "feedback@test.dk",
      "knowledgebaseId": 1
    },
    "title": "Checklist",
    "assignedTo": {
      "email": null,
      "hasChanged": false
    },
    "status": "open",
    "timeStamp": "2023-02-10T12:27:43.0145086Z",
    "lastModifiedBy": null
  }