Getting started

Step-by-step guide to setting up and using the API.

Let's walk you through everything you need to start integrating and using API v2! In this guide, you'll learn how to authenticate and make your first API calls to retrieve data for a specific group. The steps are as follows:

1. Obtain API v2 credentials.
   Note: API v1 credentials are not compatible and cannot be used for this version of the API.
2. Get an access token.
3. Make your first API call using the access token.

🔒

Important security notice

By default, API calls are executed with platform-admin-level access, allowing broad permissions across the platform. This includes the ability to create, read, update, and delete resources and data. Use this access responsibly when making requests.

Prerequisites

Before diving in, please make sure you have the following essential components ready:

• Technical setup:
  • curl: Make sure curl is installed on your computer if you plan to use your terminal.
  • API reference portal: You can also test API calls directly on our API reference portal, which features an interactive request interface.
• Account and access:
  • Platform account: You’ll need an active account on the 360Learning platform.

Let's get started!