Skip to content

API: Integrations endpoints

/integrations

GET /integrations

List owned and managed integrations.

[] Input:

  • string search: optional search string to filter results
  • integer limit: limit number of results
    • default: 16
  • integer page: page number
    • default: 1
    • not used in search mode!

[] Output:

  • list
    • string integration: integration identification string
    • string/null id: external unique integration identifier (if set for the integration)
    • string name: title of the integration

/integration

GET /integration

Get/check integration.

[] Input:

  • [!] string integration: integration identification string

[] Output:

  • string integration: integration identification string
  • string/null id: external unique integration identifier (if set for the integration)
  • string name: title of the integration
  • string type: type of the integration
    • api: EduBase API
    • moodle: Moodle LMS
    • canvas: Canvas LMS
    • d2l: D2L LMS
    • schoology: Schoology LMS
    • lms: other LMS
  • boolean active: integration is active
  • boolean lti: LTI version
    • only present if the integration is an LMS integration

POST /integration

Create a new API or LMS integration.

[] Input:

  • [!] string title: title of the integration
  • string description: optional short description
  • string type: type of the integration
    • possible values: api / moodle / canvas / d2l / schoology / lms
      • api: EduBase API integration
      • moodle/canvas/d2l/schoology: selected LMS integration
      • lms: other LMS integration
    • default: api
  • [!] string lti: LTI version
    • only necessary if the integration is an LMS integration
    • possible values: 1.0/1.1 / 1.3
      • 1.0/1.1: LTI 1.0 or 1.1
      • 1.3: LTI 1.3 (also known as LTI Advantage)
  • [!] string platform: LMS platform URL
    • only necessary if the integration is an LMS integration

[] Output:

  • string integration: integration identification string

PATCH /integration

Update integration.

[] Input:

  • [!] string integration: integration identification string
  • boolean active: enable or disable integration

DELETE /integration

Remove integration.

[] Input:

  • [!] string integration: integration identification string

/integration:keys

GET /integration:keys

Get integration keys/secrets.

[] Input:

  • [!] string integration: integration identification string

[] Output:

  • string app: API application identification string
    • only present if the integration is an API integration
  • string consumer: consumer key
    • only present if the integration is an LMS integration using LTI 1.0/1.1
  • string secret: secret key
    • only present if the integration is an API integration or an LMS integration using LTI 1.0/1.1
  • string jwk: URL for the JWK (JSON Web Key) set
    • only present if the integration is an LMS integration using LTI 1.3
  • string pem: PEM formatted public key
    • only present if the integration is an LMS integration using LTI 1.3

POST /integration:keys

Rotate integration keys/secrets.

[] Input:

  • [!] string integration: integration identification string

[] Output:

  • string app: API application identification string
    • only present if the integration is an API integration
  • string consumer: consumer key
    • only present if the integration is an LMS integration using LTI 1.0/1.1
  • string secret: secret key
    • only present if the integration is an API integration or an LMS integration using LTI 1.0/1.1
  • string jwk: URL for the JWK (JSON Web Key) set
    • only present if the integration is an LMS integration using LTI 1.3
  • string pem: PEM formatted public key
    • only present if the integration is an LMS integration using LTI 1.3