Quick start guide

Integrating your application with the HowToo API gives you access to the platform’s powerful capabilities, enabling you to create, manage, and track engaging learning experiences programmatically. Follow this guide for a straightforward setup to get started.

Step 1: Review the API documentation

Before diving into integration, familiarize yourself with the HowToo API documentation. The documentation provides detailed information about available endpoints, request formats, and response structures. Understanding these will ensure a smoother development process.

HowToo API documentation: https://howtoo.stoplight.io/docs/howtoo-api/l8y9ujcjjh2wy-how-too-api-document

Step 2: Generate an API key

To interact with the HowToo API, you need an API key. This key authenticates your requests.

• Log in to your HowToo account as primary admin.
• Navigate to the API Management section in your dashboard.
• Generate a new API key and copy it. Important: Store this key securely, as it will not be shown again.

Step 3: Set up your development environment

Prepare your application to send requests to the HowToo API.

Install required tools

• Use a REST client like Postman for testing API calls.
  • Postman: https://www.postman.com/
• Ensure your application has libraries for making HTTP requests (e.g., Axios for JavaScript, Requests for Python).

Example code snippet

Here’s a basic example using Python:

import requests

API_KEY = "your-api-key-here"
BASE_URL = "https://api.howtoo.co/v1"

headers = {
   "x-api-key": API_KEY,
   "Content-Type": "application/json"
}

# Example: Get a list of courses

response = requests.get(f"{BASE_URL}/lessons/{lessonId}/package", headers=headers)

if response.status_code == 200:
   print("Courses:", response.json())

else:
   print("Error:", response.status_code, response.text)

Step 4: Test API endpoints

Use your API key to test basic endpoints like retrieving a list of exported packages from a lesson. For example:

API doc: https://howtoo.stoplight.io/docs/howtoo-api/fdtbhhd2vfl5q-retrieve-exported-versions-of-a-lesson

Request format:

GET /v1/lessons/{lessonId}/package HTTP/1.1
Host: api.howtoo.co/v1
x-api-key: 

Response:

{
  "message": "Package handler",
  "data": [
     {
       "packageId": 6356,
       "type": "link",
       "link": "",
       "createdAt": "2025-02-04T02:13:43.000Z",
       "expire": null
     }
   ]
}

Testing helps validate that your setup is correct and the API key works as expected.

Step 5: Build your integration

Incorporate the API calls into your application based on your needs. Common tasks include:

• Fetching course data: Retrieve course details or analytics.
• Managing users: Add or remove users programmatically.

Best practices

• Secure your API key: Store it securely using environment variables or a secrets manager.
• Handle errors gracefully: Implement robust error handling for scenarios like invalid keys, rate limits, or server downtime.
• Monitor usage: Regularly check API usage logs to track activity and detect anomalies.

Examples of common use cases

Launch HowToo on the integrated application

By calling the API, a user can launch the HowToo authoring tool from the integrated application. 

Download exported package

The integrated application can download the exported package or retrieve the shareable link for a HowToo lesson by calling the APIs.

Coming soon - embedding of learning

By using the code to embed learning into your ecosystem you can surface learning in your product without the user ever needing to leave your product. Think of it like this… as Twilio is for text or Sendgrid for email, HowToo is for learning. Here is an example of how it could look once implemented.

Coming soon - user management webhook

By listening to the user management webhook, external systems can stay up-to-date on changes to user information in Howtoo Academy. This information can be used to keep external systems in sync with Howtoo Academy, or to trigger automated actions based on user events.

Coming soon - course/lesson tracking webhook 

By subscribing to course/lesson tracking webhook, external systems can receive real-time notifications of course and lesson progress for their integrated learners. This information can be used to trigger various actions, such as updating learner records, sending notifications, or syncing data with other systems.

 

HowToo system architecture

Following is a diagram showing the HowToo system architecture for your reference.

Summary

By following this quick start guide, you’ll be on your way to leveraging the HowToo API effectively. For further assistance, consult the official documentation or contact HowToo support, [e-mail].