Authenticatie en autorisatie

In het Portal kan een beheerder een Partner aanmaken en daar rechten aan koppelen. Hoe dit in zijn werk gaat staat op onze handleiding voor gebruikers. De beheerder kan bij die partner ook een authcode aanmaken. Deze authcode is eenmalig in te wisselen voor een token. Dat gaat als volgt:

POST /api/oauth/token?code=123456789012  

{
  "access_token": "abc123abc123abc123abc123ab",
  "token_type": "bearer",
  "expires_in": 123456
}

Sla dit token na het ophalen direct ergens veilig op, want het is geen tweede keer op te halen!

Vervolgens kunt u dit token in ieder request meesturen in de Authorization header: Authorization: Bearer <access_token>.

Om te achterhalen welke rechten uw token heeft, kunt u gebruik maken van het endpoint /api/partners/~me

GET /api/partners/~me
Authorization: Bearer abc123abc123abc123abc123ab

{
  "name": "Partner",
  "token": {
    "expirationDate": "19-01-2038",
    "expires": 2147483647,
    "token": "abc1**********************",
    "creationDate": "01-01-1970",
    "created": 0
  },
  "endpoints": [
    {
      "writeFields": [],
      "readFields": [
        "firstName",
        "lastName",
        "code",
        "prefix"
      ],
      "endpoint": "users",
      "filterFields": [
        "firstName",
        "lastName",
        "code",
        "prefix",
        "fields",
        "schoolInSchoolYear"
      ]
    }
  ],
  "schoolInSchoolYears": [
    {
      "schoolYear": 2025,
      "school": {
        "id": 1,
        "name": "VoorbeeldSchool"
      },
      "id": 1001702
    },
    {
      "schoolYear": 2026,
      "school": {
        "id": 1,
        "name": "VoorbeeldSchool"
      },
      "id": 1001802
    }
  ]
}

Dit geeft u informatie over uw partner token zelf, met name tot wanneer het geldig is. Ook ziet u aan welke roosterprojecten van het Portal u als partner gekoppeld bent. En u ziet de endpoints waar u toegang tot hebt gekregen met de precieze velden die u mag opvragen.