Seduo Company API Documentation

Overview

The Seduo Company API provides access to course catalogs for companies with valid contracts. The API is designed for external integration with LMS systems like SAP SuccessFactors and provides complete course information including metadata.

Key Features

• Two Course Types: Standard courses and microlearning content
• Multi-format Support: Both XML and JSON response formats
• Rate Limiting: 10 requests/minute, 100 requests/hour per company/IP
• Security: Bearer token authentication with role-based access

Authentication

The API uses Bearer token authentication. You must include a valid authorization token in the request header.

Requirements

• Valid company contract
• Authorization token configured in company administration
• Bearer token in Authorization header

Header Format

API Endpoints

Parameters

Response Codes

Data Structure

Response Structure

The API returns a structured response containing metadata and course resources.

Metadata

Course Resource Fields

Examples

Request Examples

Standard Courses

Microlearning Courses

JSON Response Example

XML Response Example

Error Codes

The API returns standard HTTP status codes along with descriptive error messages.

Error Response Format

Common Error Scenarios

400 Bad Request

401 Unauthorized

429 Too Many Requests

500 Internal Server Error

Rate Limiting

The API implements rate limiting to ensure fair usage and system stability.

Limits

Rate Limit Headers

All responses include rate limit information in headers:

• X-RateLimit-Remaining-Minute - Remaining requests in current minute
• X-RateLimit-Remaining-Hour - Remaining requests in current hour
• X-RateLimit-Limit-Minute - Maximum requests per minute (10)
• X-RateLimit-Limit-Hour - Maximum requests per hour (100)

Rate Limit Exceeded

When rate limit is exceeded, the API returns HTTP 429 with a Retry-After header indicating when to retry.

Downloads

Download the API documentation in various formats for integration with your tools.

Integration Tools

Swagger UI

View and test the API in Swagger UI:

1. Open https://editor.swagger.io/
2. Import the YAML or JSON file
3. Browse the documentation and test the API

Postman

Import into Postman for testing:

1. Download the JSON file
2. Open Postman and click "Import"
3. Select the downloaded JSON file
4. Configure Bearer token in Authorization tab
5. Test the endpoint with different formats

Code Generation

Generate client libraries using tools like:

• OpenAPI Generator: https://openapi-generator.tech/
• Swagger Codegen: https://swagger.io/tools/swagger-codegen/

SSO (Single Sign-On)

Companies with landing pages can configure different authentication methods for their users. This affects how employees access courses through the company portal.

Authentication Types

Three authentication methods are available for companies:

1. Basic Authentication

• Method: Email + Password
• Configuration: No additional setup required
• User Experience: Standard login form on company landing page
• Security: Password-based authentication with optional password policies

2. Two-Factor Authentication (2FA Email)

• Method: Email + Password + Email Verification Code
• Configuration: Set authentication type to 2fa-email
• User Experience: After login, users receive email with verification code
• Security: Enhanced security with email-based second factor
• Code Validity: Verification codes expire after a set time period

3. Single Sign-On (SSO Azure)

• Method: SAML2-based SSO with Azure AD
• Configuration: Requires Azure AD setup and SAML2 configuration
• User Experience: Seamless login through company's Azure AD
• Security: Enterprise-grade security managed by Azure AD
• User Management: Centralized user management through Azure AD

SAML2 Configuration

For companies using SSO Azure authentication, the following SAML2 configuration is required:

Required Configuration Parameters

SAML2 Metadata

Each company with SSO authentication has its own SAML2 metadata endpoint:

This endpoint provides the Service Provider (SP) metadata that needs to be configured in Azure AD.

SAML2 Metadata Example

Example of SAML2 Service Provider metadata for company SSO configuration:

SAML2 Authentication Request Example

When redirecting to Azure AD, the system generates a SAML AuthnRequest:

Azure AD Configuration

To configure Azure AD for SAML2 SSO with seduo.cz:

1. Create Enterprise Application: Add new enterprise application in Azure AD
2. Configure SAML: Set up SAML-based sign-on
3. Set Identifier: Use company's metadata URL as identifier
4. Set Reply URL: Use company's login_check URL
5. Configure Claims: Map user attributes to SAML claims
6. Assign Users: Assign company users to the application

Required Azure AD Claims Mapping

SAML2 Authentication Flow

1. User Access: User visits company landing page
2. SSO Redirect: System detects SSO configuration and redirects to Azure AD
3. Azure Authentication: User authenticates with Azure AD credentials
4. SAML Response: Azure AD sends SAML response with user attributes
5. User Verification: System verifies user exists in company or initiates registration
6. Login Complete: User is logged in and redirected to courses

Company Landing Page Requirements

Landing Page URL Structure

Where {company-slug} is the unique identifier for the company's landing page.

User Registration Flow

When users don't exist in the system, different registration flows are available:

• Self-Registration: Automatic user registration for allowed domains
• Manual Approval: Registration requests require admin approval
• SSO Registration: Automatic registration from SAML attributes
• Invitation System: Email invitations for existing users without passwords

xAPI Integration

The Resources API integrates with the Experience API (xAPI) standard to track learning activities and generate standardized learning statements when students complete courses.

How xAPI Works with Resources API

When a student completes a course obtained through the Resources API, the system automatically generates xAPI statements that conform to the xAPI specification. These statements provide detailed information about the learning experience.

xAPI Statement Structure

Each xAPI statement follows the pattern: Actor + Verb + Object + Result

Course Completion Statement Example

Here's an example of an xAPI statement generated when a student completes a course:

xAPI Statement Components

Supported xAPI Verbs

The system supports various xAPI verbs depending on the learning activity:

• completed - Student finished the entire course
• passed - Student successfully passed the course assessment
• failed - Student did not pass the course assessment
• experienced - Student accessed/viewed course content
• attempted - Student started an assessment or activity
• progressed - Student made progress through the course

xAPI Extensions

Seduo.cz uses custom xAPI extensions to provide additional course-specific data:

Integration Benefits

• Standardized Tracking: Consistent learning data across all systems
• Interoperability: Data can be shared with other xAPI-compliant systems
• Analytics: Rich learning analytics and reporting capabilities
• Compliance: Meets industry standards for learning data
• Detailed Insights: Comprehensive learning activity tracking