DOCSEARCHbyAlgolia
Submit Docs

Xporter API Documentation

website·Indexed 32 days ago

https://docs.xporter.com

A suite of APIs for school data integration and communication, featuring SCIM 2.0 for identity management, OneRoster support for educational data, and a Communications API for multi-channel messaging and push notifications. Includes tools for school-scoped authentication, bearer token management, and identity provisioning.

Tokens
17.2K
Snippets
90
Records
134
Agent score
49%

What's inside Xporter

  1. Overview of Xporter Identity API capabilities

    Xporter Identity provides identity-management endpoints designed for school and management integrations. It allows developers to provision and maintain user access within an authenticated establishment. Key capabilities include retrieving user data, creating logins or manual users, resetting passwords, and generating or assigning QR codes for sign-in workflows.

  2. Overview of VenturEd Solutions Communications API capabilities

    The VenturEd Solutions Communications API allows developers to send multi-channel messages to students, parents, and staff. Key capabilities include:

    • Multi-Channel Messaging: Support for Push notifications (Eduspot app), rich Timeline content (Eduspot app), SMS with delivery tracking/callbacks, and personalized HTML emails.
    • Smart Routing: Automatic delivery optimization based on recipient preferences.
    • Education Integration: Integration with school management systems, compliance with education data protection, and message history tracking within Groupcall and Teachers2Parents platforms.
    • Billing: Ability to pass message charges to specific schools for messages sent on their behalf.
    • Developer Tools: RESTful API design, a sandbox environment for testing, and real-time delivery status updates via webhooks.

  3. Understand Xporter on Demand data caching and TTLs

    Xporter on Demand uses a caching layer between the MIS and API endpoints to improve performance. Data is stored in encrypted databases with specific Time To Live (TTL) values. Most databases are refreshed automatically every night around 03:00 UTC. For endpoints requiring specific parameters (like dates), data is fetched in real-time unless a cached request with the same parameters already exists, in which case expired data is returned immediately while fresh data is fetched in the background.
    Database NameTTL (Minutes)Refresh Mode
    XodSchoolData1440Auto (Overnight)
    XodAttendanceSummary1440Auto (Overnight)
    XodAssessmentTables1440Auto (Overnight)
    XodAttendanceForDate (Today)30Auto (Overnight/On Request)
    XodConductForToday30Auto (Overnight/On Request)
    XodConductPoints30Auto (Overnight/On Request)
    XodConductForDateRange720On Request
    XodAssessmentResults30On Request
    XodEndpointInfo5On Request

  4. Xporter OneRoster API Overview

    Xporter provides a compliant IMS Global OneRoster v1.1 API for third-party systems to retrieve rostering data, including organisations, users, classes, enrolments, and academic sessions from connected schools.
    Base URL: https://xporter.groupcall.com/ims/oneroster/v1p1

  5. Xporter OneRoster v1.1 API Overview

    Xporter provides a school-scoped IMS OneRoster v1.1 API for partners to retrieve rostering data for specific schools. The API base URL is https://xporter.groupcall.com/ims/oneroster/v1p1/.
    https://xporter.groupcall.com/ims/oneroster/v1p1/

  6. Xporter SCIM 2.0 API Overview

    Xporter provides a school-scoped SCIM 2.0 API to provision users and groups from school MIS data. The API operates in pull mode only, meaning it acts as the source of truth. Identity Providers (IdPs) read data from Xporter; write-back operations (POST, PUT, PATCH, DELETE on /Users or /Groups) are not supported and will return a 405 Method Not Allowed status. When configuring connectors like Microsoft Entra ID or Okta, use import-only mode.

  7. Understand the Xporter API authentication security model

    Xporter API uses a per-school authentication model to ensure high security and data segregation. Instead of a single global API key, the system generates a unique schoolSecret every time a school authorizes an application. This secret is sent via a POST request to the application's defined authorisationURL. To access the API, the application must use the schoolSecret to generate a time-limited token. This architecture prevents a single compromised key from exposing multiple schools and ensures that an authenticated session can only return data for the specific school associated with that token.

  8. Understand Xporter API Token types

    Xporter provides two distinct types of tokens to control authorization and data access:

    1. Management Tokens: Used to access Management and Automation APIs. These do not provide access to school-level data.
    2. School Tokens: Used to access School Data APIs. These are unique to each school that authorizes your application.

  9. Implement Embedded Elements in Eduspot app messages

    Embedded Elements are components included in message content that render as interactive elements in the Eduspot app timeline. They follow a specific XML-like format where the element type is defined and the configuration is provided as a Base64 encoded JSON string.
    <x-TYPE data="PAYLOAD" />
    • TYPE: The action or service the element represents.
    • PAYLOAD: A Base64 encoded JSON string containing configuration instructions.

  10. Xporter SCIM API Integration Checklist

    Follow these guidelines for a successful integration:

    • Credentials: Use the relying party identifier (rp), establishment identifier (estab), and shared secret.
    • Token Management: Cache the access_token and reuse it until the expires_in duration has passed. If a 401 is received, re-authenticate and retry once.
    • Pagination: Use startIndex and count for large result sets.
    • Efficiency: Use filter=meta.lastModified gt "<timestamp>" for delta syncs after the initial load.
    • Deletions: Treat users with active: false as candidates for deletion.
    • Relationships: Group member value fields correspond directly to User id fields.

  11. Register an application for Xporter API access

    To use the Xporter API, you must register your application to obtain access credentials. The registration process involves three main steps:

    1. Submit Registration: Provide your application details via the registration form.
    2. Email Verification: Verify your contact information through the email sent to you.
    3. Xporter Management: Once verified, your email provides access to Xporter Manage, where you can configure your application and use the API sandbox.

    Required Information for Registration:

    • Application Name: A descriptive name for your app.
    • Host Name: The domain or hostname used to uniquely identify your application.
    • Contact Details: A valid email address and mobile number.