SameGoal provides streamlined alerts and document viewer integrations for popular student information systems (eg Infinite Campus, PowerSchool, etc).
This document viewer integration is also available to other third-party applications (eg other student information systems, dashboards and toolbars) to integrate student Special Programs documents from SameGoal within their applications.
- SameGoal provides an API located at api.samegoal.com
- Each state includes a docViewer endpoint that can be used by third-party applications to incorporate Document Viewer links into their application. See example (API endpoint documents use and suggestions).
lightbulb Tip
To setup a document viewer integration with a third-party application- Third-party vendor communicates whether it prefers to
- make calls to the REST-based API, or
- prefers SFTP file pushes
- District provisions API access for data export.
- If vendor will make calls to the API:
- District shares API account Client ID and Client Secret with vendor.
- Vendor may then use these API credentials.
- If vendor prefers SFTP file push:
- Vendor communicates its SFTP account:
- Host
- Username (defaults to "samegoal")
- Directory (location to place file)
- File format (CSV, JSON, XML)
- District enters this configuration information for the data export in the web UI.
- Vendor installs SameGoal's public key used by SameGoal integrations.
- Vendor integrates document viewer links into its application.
lightbulb Tip
API calls may be made at any time. SFTP file pushes are performed nightly.