@kth/ladok-api v0.3.1

ladok-api

This project version is currently 0.x, meaning that any update can cause any breaking change in its API without any announcement

Usage

const LadokApi = require('@kth/ladok-api')
const fs = require('fs')

;(async function start () {
  const ladok = LadokApi(process.env.LADOK_API_BASE_URL, {
    pfx: fs.readFileSync('./my-certificate.pfx'),
    passphrase: process.env.LADOK_API_CERT_PASSPHRASE
  })

  console.log((await ladok.test()).body)
})()

API

LadokApi(baseUrl, sslOptions)

Returns a LadokApi instance. Two arguments are required:

1. baseUrl. The base URL for calls performed by the instance.

2. sslOptions. An object containing the SSL certificate provided by Ladok.

   • If you have a .pfx file, pass it in pfx
   • If you have a .cert file and the .key, pass them in cert and key.
   • Additionally, pass a passphrase if needed.

const ladok = LadokApi(process.env.LADOK_API_BASE_URL, {
  pfx: fs.readFileSync('./my-certificate.pfx'),
  passphrase: process.env.LADOK_API_CERT_PASSPHRASE
})

Instance methods

ladokApi.test()

Make a request to the /kataloginformation/anvandare/autentiserad endpoint in Ladok. Useful when you want to check that you have set up the environment properly.

If everything goes well, it returns a string with the response of the mentioned endpoint.

const response = (await ladok.test()).body

ladokApi.requestUrl(endpoint, method, parameters)

Make a request to a certain endpoint with a specific method. Use parameters (the third argument) to pass body parameters.

ladokApi.sok(endpoint, criteria, key)

Make a "sok"-type request to Ladok. Parameters:

1. endpoint. The endpoint to do the request.
2. criteria. Object to pass as search criteria. It will be passed as body parameters in the request.
3. key. Key in the response object that contains the array to traverse.

Returns an iterator object to traverse through each of the results.