# Getting Started

# API

This is a general, step-by-step guide for getting started with the Classpert API. For more details, please read the API Documentation

# Login to User Account

Before using the API, it's necessary to login (opens new window) at Classpert. If you don't have a Classpert User Account yet, please create one at Classpert Sign Up Page (opens new window)

# Prove your Provider's Domain Ownership at the Developer Dashboard

A Provider is a verified website where your Courses are hosted.

To add new websites to your account, please visit the Classpert Dashboard (opens new window)

For more information, please read the Dashboard Documentation Page;

# Retrieve your API Key

Once you have successfully registered you Provider's Domain Ownership, an API Key will be generated for your User Account.

Please remember that the API Key will only be shown to you once. If the API Key is lost, there is no way to retrieve it, and a new one must be generated.

Example API Key:

2DG13IFKQQWDhxE5qc0rgw.SH6VJJelRIWSENihKwAKIwVQGVHNLvSW-_Ii2x6-75KgO70MIJyXSBGnXr1Qt8iESgcFdzlZxjT4m0dgE4BPtAdA

For more information on Classpert's API Keys, please read the API Keys Documentation Page

# Test your API Key

Once your API Key is generated, test it with a simple GET request on the Providers API, including your API Key in the X-Api-Key header.

cURL example:

curl 'https://api.classpert.com/developer/v1/providers' \
   -H 'X-Api-Key:  2DG13IFKQQWDhxE5qc0rgw.SH6VJJelRIWSENihKwAKIwVQGVHNLvSW-_Ii2x6-75KgO70MIJyXSBGnXr1Qt8iESgcFdzlZxjT4m0dgE4BPtAdA'

The above call will return all the Providers belonging to the API Key's User Account.

For more details, please read the Courses API and the Providers API Documentation Pages