Flourish QMS

Documentation

Florisage API

REST API for integrating with Florisage — organizations, users, courses, enrolments, certificates, and webhooks.

Base URL

https://florisage.com/api

Version

v1.0

Format

JSON over HTTPS

OpenAPI spec

Quick start

  1. 1

    Create a developer account

    Sign up with your email — it takes a minute.

    Create an account
  2. 2

    Apply for API credentials

    Tell us what you're building and which scopes you need. We review it, then email your client ID and secret once.

    New application
  3. 3

    Get an access token

    Trade your credentials for a token that lasts one hour.

    curl
    curl -X POST "https://florisage.com/api/v1/oauth/token" \
  -H "Content-Type: application/json" \
  -d '{ "client_id": "your-client-id", "client_secret": "your-client-secret" }'
  4. 4

    Call the API

    Send the token as a bearer token on every request.

    curl
    curl "https://florisage.com/api/v1/courses?limit=5" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Guides

Getting credentialsHow applications are reviewed, and when your client ID and secret arrive. AuthenticationExchange your credentials for a one-hour access token. Organization scopingWhy every request only ever sees your own organization's data. PaginationThe limit and offset parameters every list endpoint takes. ErrorsThe error format, and every code you can expect to see. WebhooksReceive signed events for enrolments, certificates, users and courses. Partner integrationsHow a named partner connects many organizations with a one-time consent code.

API reference

All endpoints

Authentication

Exchange your application's credentials for a short-lived access token.

Seats

Check how many course seats your organization has, and how many are in use.

Learners

The learners on your organization's own list.

Courses

The published course catalogue and its categories.

Enrolments

Enrol learners in courses, track progress, and mark enrolments complete.

Certificates

Certificates earned by your organization's learners.

Webhooks

Subscribe to events and have Florisage deliver them to your own endpoint.