This repository has been archived by the owner on Jun 29, 2021. It is now read-only.
adds docs for integrations api and updates API schema definitions #15
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jmcd
reviewed
Jul 5, 2018
| @@ -0,0 +1,75 @@ | |||
| # Integrations API | |||
|
|
|||
| Integrations can be established between a Health platform account and any configured 3rd party service. This connection can be established and revoked by an individual and allows the Health platform to conenct into the 3rd party service using an account specified my an individual. Integrations utilise OAuth2 protocols to securely allow connectivity and allows the Health platform to interactive with specific scopes and data as consented by the owner of the 3rd party service account. | |||
There was a problem hiding this comment.
typo: "conenct"
typo: "to interactive"
commas: and ... and
jmcd
reviewed
Jul 5, 2018
|
|
||
| ## Using Integrations as an application developer | ||
|
|
||
| As an application developer you can utilise these connections to perform specific integration actions on behalf of a logged in Health platform user and a 3rd party service within your client application, however the Health platform will acts as a gatekepper between your application and the 3rd party to protect the flow and quality of information passing between you, the health platform and a 3rd party. |
jmcd
reviewed
Jul 5, 2018
|
|
||
| ## Response | ||
|
|
||
| An array of json objects representing each integration your client is trusted to use, along with some status information |
jmcd
reviewed
Jul 5, 2018
|
|
||
| ## Using the `connectUri` to initiate a request to establish an integration connection | ||
|
|
||
| The `connectUri` is returned from a call to the integrations status api endpoint and returning a uri that can be used by the client application should the integration not be established, redirecting will begin the connection process, forwarding the user to the login/consent pages for the 3rd party service. Once the connection is establioshed the user will be returned to the health platform integrations summary page by default. The `connectUri` supports additional query parameters that can be used to redirect back into your application when the integration connection is completed (whether successful or not): |
jmcd
reviewed
Jul 5, 2018
|
|
||
| ## Using the `connectUri` to initiate a request to establish an integration connection | ||
|
|
||
| The `connectUri` is returned from a call to the integrations status api endpoint and returning a uri that can be used by the client application should the integration not be established, redirecting will begin the connection process, forwarding the user to the login/consent pages for the 3rd party service. Once the connection is establioshed the user will be returned to the health platform integrations summary page by default. The `connectUri` supports additional query parameters that can be used to redirect back into your application when the integration connection is completed (whether successful or not): |
There was a problem hiding this comment.
typo: "establioshed"
consider breaking up long sentences. a
void content in parens.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.