Integration scenarios

We invite you to choose one of three possible scenarios that best suits your needs.

	I. System as user	II. Integration with user management and access to GoSpeech interface	III. Integration with self-sufficient users
OAuth grant type	Resource owner password	Client credentials and resource owner password	Authorization code with PKCE
System is treated as one user	✔️	⛔	⛔
Payment	The `<<glossary:developer>>` pays for all of your system users.	Thr developer pays for all of your system users.	Each end-user pays for themselves in accordance with their GoSpeech Client billing plans .
`<<glossary:Managed User>>`	⛔	✔️	⛔
Two-factor authentication	⛔	⛔	✔️
Access to end-user's`<<glossary:Record>>`s	The developer is able to see, open and edit all records in his `<<glossary:Worklist>>` which were uploaded from your system (by developer themselves as well as all assosciated end users).	The developer is not able to see the records of your end users. Yet, the developer can upload and see his/ her own files.	The developer is not able to see the records of your end users. Yet, the developer can upload and see his/ her own files..

I. System as user

In this scenario, the users of your system are not differentiated. When your end-user uploads a file, it will be treated as a file uploaded by your system. If it is necessary for your use case to separate users, then you should either implement user management on your side or select another integration scenario.

A simplified possible usage scenario:

You configure the connection between GoSpeech and your system.
Your system uploads the file.
Your system gets a list of all <<glossary:Record>>s.
Your system gets a record status update.
Your system gets the <<glossary:Transcript>> in JSON (see 🔍Transcript reference), DOCX, TXT, PDF formats.
Your system deletes the record.

II. Integration with user management and access to GoSpeech interface

Your end-user have their own <<glossary:Managed User>> GoSpeech accounts. These accounts are created through API by your system. Managed userd can't login to GoSpeech as a regular user with a login form as there is no username-password pair for them. Yet, managed users can still access GoSpeech Client interface.

A simplified possible usage scenario:

You configure the connection between GoSpeech and your system.
You add your end-users with Create managed user API.
Your end-user initiates file upload from your system.
The file is sent to GoSpeech.
This file is displayed in your system interface and its status is being updated (see Notifications to learn how to handle status updating).
If the file is recognized, the end-user can open the <<glossary:Record>> in GoSpeech interface. See Record Statuses to learn about the record lifecycle.
Your end-user also is able to open their <<glossary:Worklist>> in GoSpeech and use other features of the GoSpeech Client.
The <<glossary:Developer>> is able to remove their end-users from GoSpeech.

III. Integration with self-sufficient users

To upload a <<glossary:Record>> from your system to GoSpeech, the user must be authorized. If that prerequisite is not met, your system redirects them to GoSpeech Login page.

A simplified possible usage scenario:

You configure the connection between GoSpeech and your system.
End-user registers in GoSpeech directly on their own with username-password pair or with SSO.
Your end-user initiates file upload from your system.
Your system redirects end-user to GoSpeech Login page.
End-user logs into GoSpeech, is redirected and the upload starts.