Authenticatie

Api key aanmaken

Authenticatie loopt door middel van een API key. Als functioneel beheerder is het mogelijk om API keys aan te maken. Je kunt API keys verschillende rechten en restricties op organisaties geven.

De API key kan je vervolgens meegeven als header parameter en is verplicht bij alle API calls.

Meesturen van een organisation (verplicht)

Als je gebruik wilt maken van de API is het verplicht om een organisation mee te geven. Evalytics weet dan welke items teruggestuurd moeten worden of onder welke organisatie een item geplaatst of bijgewerkt moet worden. Dit kan zowel een extern id als het interne id van de organisation zijn (zie hoofdstuk Algemene query parameters)

Api voorbeeld

GET https://api-portal.evalytics.xyz/groups

Hieronder zie je een voorbeeld van een call die je kan aanroepen om een lijst met groepen op te halen

Query Parameters

Name	Type	Description
organisation	string	Id van de organisation (kan ook een externalId zijn)

Headers

Name	Type	Description
api-key	string	Api key token

200

{
  "metadata": {
    "timestamp": "2021-02-22T20:35:30.186Z",
    "resultSet": {
      "count": 1,
      "limit": 30
    }
  },
  "results": [
    {
      "organisation": 1,
      "topOrganisation": 1,
      "deleted": false,
      "createdBy": "123",
      "modifiedBy": null,
      "externalId": null,
      "archived": false,
      "name": "Groep studenten",
      "description": "Studenten",
      "id": 1772,
      "createdAt": "2020-12-21T16:17:55.000Z",
      "updatedAt": "2020-12-21T16:17:55.000Z"
    }
  ]
}