The general GroupShare API documentation can be found here:
http://gs2017dev.sdl.com:41234/documentation/api/index#!/Login/Login_signin

The special TM GroupShare API documentation can be found here:
http://gs2017dev.sdl.com:41235/docs/ui/index#!/Search/Search_Post

Dokus:
SDL Trados GroupShare 2017
SDL Translation Memory API

translate5-GroupShare-Plugin:
https://confluence.translate5.net/display/GROUPSHARE/Basic+usage
https://confluence.translate5.net/display/GROUPSHARE/GroupShare-Plugin

Step 1 ("as light and as quick as possible"):

General concept

In general the integration of GroupShare will be according to the MatchResource-concept, as developed as result of the crowdfunding:

• When a user needs access to GroupShare translate5 (eg. while editing a task that uses GroupShare or for managing LanguageResources), the API will trigger the login into GroupShare. Different users work with different licences; this is a necessary requirement by GroupShare. (Pls note: Since we use the DB for caching, all users whose licences we manage are required to use the same translate5 instance.)
• Existing GroupShare TMs are listed in the MatchResoure overview of translate5. (All TMs that are available for the user are listed. Using the TM name in translate5 is enough, we do not need the organizational name.)
• MatchResources can be assigned to tasks in the task properties of the task overview and of course through translate5s REST API
• If one or more GroupShare TMs are assigned to a task for reading, on opening a segment they will be searched for matches (fuzzy matches and 100% matches). Note: GroupShare's 100%-matches can differ depending on the context!
• Same is true for the concordance search
• On MouseOver the metadata of the matches are shown (including TaskName and TaskGuid from translate5 if they exist).
• If one or more GroupShare TMs are assigned to a task for writing, on saving a segment the segment gets saved to GroupShare. (Include TaskName and TaskGuid when saving an entry!)
  CreationUser, ChangeUser, UseUser (= SystemFields, always relate to the GroupShare-users that we only use for the license and cannot be set via the API, so we must use CustomFields to store the users that edit in translate5). If a translate5-user is set in the CustomFields, we take this one. If not, we take the GroupShare-user from the SystemFields.

Not necessary in the first step:

• All administrational tasks related to GroupShare (TMs, users, ...) are still done in GroupShare only.
• Fragments are ignored at the moment (also in concordance search).

Further discussion needed:

• Should a changed 100% match override the existing match or be added as a new one? (Currently implemented as OVERWRITE.)

NEXT STEP:

• check issues in detail for three days, then more feedback on options and efforts

Notes for the detailed specification

As for now when reading the REST-API it is not intuitively clear, how information about context matches can be obtained. There is information about context match in the result of the search query, but it is not clear, how this relates and should be used. This has to be investigated.

Ideas for step 2:

• include GroupShare's Project-ID in the matches' metadata (from GroupShare's customized fields)
• reimport all tasks feature
• Configuration with settings when to overwrite matches.