SameGoal provides an API located at api.samegoal.com
- All reports accessible via SameGoal's web interface in each state can be accessed from this API.
- Data results can be generated in CSV, JSON, XML and/or other state specified file formats, as applicable.
- The API can be accessed any time to extract data.
- Data exports, which use the API, can also be used to schedule data extracts nightly and send them to a third-party SFTP account.
- All API access is provisioned using data imports/exports.
- Districts may create an API account for each vendor/use case; an unlimited number of API accounts can be created.
- For each API account, access can be provisioned/configured for an unlimited number of endpoints (reports).
- Each endpoint can be configured to produce data using the same report parameters available in the web interface (the same defaults are used as well, unless changed).
- Because (a) each report maps to an API endpoint, and (b) each API endpoint can be configured with the same parameters used in the report web interface, districts can easily review data expected to be pulled (or pushed) by running the report in the web interface.
- SameGoal includes reports for state reporting data in each state-specified file layout.
- The category these reports live under can vary state to state, but are typically found under stateReporting, the name of state reporting in a given state (eg EMIS, PEIMS, CALPADS, etc), or even the special programs category (eg specialEducation, if reports are minimal/specific to certain programs).
- If you are a third-party vendor developing a process to writeback state reporting data to another system (most commonly an SIS), you'll need to decide if your integration will pull data from the API, or if you'd like SFTP push of files (typically CSV). If nightly SFTP is used, districts will need to know SFTP connection information.
- Swagger documentation is provided at api.samegoal.com. Any additional questions may be sent to api@samegoal.com.
SameGoal's API is commonly used for integration with School-Based Medicaid vendors, testing coordination software, custom in-house district solutions, district dashboards, etc. If you have questions regarding how to use the API for your integration project, please email api@samegoal.com.