Integration Methods

Zipper supports a variety of automated integration technologies, which include but are not limited to the following:

• The ability for your team to develop against our Zipper REST APIs
  • API Specification Link to Download
• The ability for the SpectrumAi team to make calls to external endpoints through a variety of frameworks:
  • REST
  • HL7
  • SFTP (flat-file - .CSV)

Below are diagrams of the flow of data as part of that Zipper integration. Note that the import of legacy curriculum content and SSO fall outside of these automated workflows and will be covered in their own sections.

Zipper flat-file integration

We utilize our interface engine to ingest and parse (.CSV) flat-files as an integration method from systems or databases without sufficient API capabilities, or where the lift for an API integration is too prohibitive. Our interface engine will ingest the files from either a SpectrumAi-provided SFTP site/location, or via one you provide.

For more information on details and examples of the flat-file oriented structure (it varies from the linked API specification above), check out our Flat-File Integration Details article!

Figure 1. Illustration of the workflow where the customer’s external system exports the data for Twyll to flat-file(s) and transfers them to an SFTP server SpectrumAi provides. The customer’s external system also pulls files containing data from Twyll from the SFTP server. In this workflow, the customer collaborates with SpectrumAi to determine the structure and translation of content, and the cadence with which that data is exchanged.

Zipper API integration

We utilize our Zipper framework to make API calls to your external system's API endpoints to pull certain information and integrate that into Twyll. Zipper can also push certain information to your system. 

Figure 2. Illustration of the workflow where Twyll pulls data from and sends data to the customer’s external system via Zipper. In this workflow, the customer’s external system has an API framework that is accessible via Zipper, and the customer works with SpectrumAi to define that communication structure.

Zipper APIs called by a third party system

You may use an external API suite to push data to Twyll using our externally-accessible APIs, and to pull other information out of Twyll in the same format. 

Figure 3. Illustration of the workflow where the customer’s external system initiates the data feed to Twyll (via Zipper) and initiates the data pull from Twyll. In this workflow, the customer is responsible for developing the technical processes to access the Twyll APIs at the desired cadence.