Partnership-level API integration

HowToo offers a partnership-level API integration that allows partner platforms to create HowToo accounts programmatically. This capability streamlines onboarding and empowers partners to integrate HowToo seamlessly into their ecosystems, enhancing their users’ access to world-class learning experiences.

Key features

• Account creation automation: Enable your platform to create HowToo accounts on behalf of users without manual intervention.
• Scalable integration: Manage account provisioning for multiple users or organizations efficiently.
• Seamless onboarding: Reduce friction for end-users by automating account setup.

How it works

The partnership-level API integration provides specific endpoints designed to create and manage HowToo accounts. 

Here’s an overview of the process:

• API key generation: Partners are provided with a master API key to authenticate requests.
• Account creation endpoint: Use the /v1/partners/accounts endpoint to create accounts programmatically.
• Response handling: Ensure proper handling of responses, including account IDs and error messages.

Step-by-step guide

1. Obtain a Partnership API Key

As a partner, you’ll receive a dedicated API key for authenticating requests.

• Contact HowToo support to enable partnership-level API access.
• Once approved, retrieve your master API key.
• Store the API key securely;it’s a critical credential.

2. Set up your development environment

Prepare your platform for integration with the HowToo API.

Example Setup in Python

import requests

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

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

# Example: Create a new HowToo account
payload = {
   "primaryEmail": "[e-mail]",
   "password": "*****",
  }


response = requests.post(f"{BASE_URL}/partners/create", json=payload, headers=headers)

if response.status_code == 201:
   print("Account created:", response.json())
else:
   print("Error:", response.status_code, response.text)

 

3. Use the account creation endpoint

API doc: https://howtoo.stoplight.io/docs/howtoo-api/ngkvvlmtsxx71-create-a-how-too-account

Request format:

POST /v1/partners/create HTTP/1.1
Host: api.howtoo.co

x-api-key: <API_KEY>
Content-Type: application/json

{
 "primaryEmail": "[e-mail]",
 "password": "***",
}

Response:

{
  "message": "Integration initialized",
  "data": {
      "completePurchaseUrl": "example.howtoo.dev/tokenauth.html?token=*********&redirect=/admin/purchase-plan"
   }
}

4. Handle errors gracefully

Implement error handling to manage potential issues:

• 400 Bad Request: Missing or invalid input.
• 401 Unauthorized: Invalid or missing API key.
• 429 Too Many Requests: Rate limit exceeded.

Example error handling:

if response.status_code == 400:
  print("Invalid input:", response.json())

elif response.status_code == 401:
   print("Authentication error: Check API key.")

elif response.status_code == 429:
   print("Rate limit exceeded. Try again later.")

else:
   print("Unhandled error:", response.status_code)

Best practices for partnership integration

• Secure API keys:
  • Store API keys in secure locations (e.g., environment variables).
  • Rotate keys periodically to enhance security.
• Validate input:
  • Ensure all user inputs (e.g., email addresses) are validated before sending requests.
• Monitor usage:
  • Regularly review API usage and set alerts for anomalies.
• Test thoroughly:
  • Use sandbox environments provided by HowToo to test integration before production deployment.
• Documentation and training:
  • Document the integration process for your team.
  • Train team members on using the API effectively.

Conclusion

The partnership-level API integration with HowToo provides an efficient way to automate account creation, streamline onboarding, and deliver just-in-time learning experiences within your platform. By following best practices and integrating seamlessly, you can enhance user access to HowToo’s powerful learning platform and create a more cohesive, value-driven employee, customer and partner experience.