Eduflow
  • Welcome
  • API Reference
  • API Explorer
  • Getting started
    • API Overview
    • Authentication
    • Usage
  • GraphQL at Eduflow
    • Introduction to GraphQL
    • Variables
    • Fragments
    • Paginating queries
    • Inline fragments
  • Guides
    • Institutions
    • Courses
    • Flows and Activities
    • Reviews and Reflections
    • Discussions
    • Quizzes
    • Users & Participants
    • Tags
    • Course summary (outputs)
    • vs Peergrade
  • API Changelog
Powered by GitBook
On this page
  • API Keys
  • What can I do with API Keys?
  • How do I enable Developer settings for my institution?
  • How do I create an API access key?
  • Authentication methods
  • Bearer token (Authorization headers)
  • Via session

Was this helpful?

  1. Getting started

Authentication

PreviousAPI OverviewNextUsage

Last updated 4 years ago

Was this helpful?

API Keys

What can I do with API Keys?

As of right now, this opens up access to our GraphQL API. Stay tuned to for more ways your API key can be used to integrate with third party services.

How do I enable Developer settings for my institution?

Developer settings are available to Institutions with a .

From there, administrators and owners will be able to use their institution dashboard (accessible via top-left menu) to create keys.

How do I create an API access key?

API Keys are required to use the GraphQL API and other API Key related features can be created through the Developer API settings:

And within the Developer API section:

The institution's API key can be revoked, which will prevent future requests from accessing with that key.

If you would like a test / developer institution created for development, contact our support.

Authentication methods

Bearer token (Authorization headers)

Authorization: Bearer <api_key>

Ways to pass authorization headers

See also

Via session

For examples, see the .

Authentication is passed via bearer token. This is done via taking your institution's passing it in the in this format:

In browser, via an extension that modifies requests (e.g. )

Terminal usage: via curl(1) or wget(1) (see )

Programmatically via network requests (see )

on MDN Web Docs

Similar: ()

Similar: ()

Similar: ()

You can access https://app.eduflow.com/api/graphql and Login as an institution owner / admin to access graphiql directly. To see this in action see the .

Usage page
Postman
HTTP Headers > Authorization
Swagger's Bearer authentication method
archive.org
Postman docks on Bearer authentication
archive.org
RFC6750 / OAuth 2.0 Authorization Framework: Bearer Token Usage
archive.org
Authorization HTTP Header
API key
Pro level plan or greater
examples
examples
graphiql usage example
You can navigate to your Dashboard via the top left-menu
From within the Institution Dashboard
Clicking "Generate API Key" will produce a key to access your institution