Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[POC] Support to bundle_oauth and bundle_integration_key #272

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

7ail
Copy link

@7ail 7ail commented Feb 25, 2020

Description

Install App

In order to utilise the external OAuth Client created here, changes need to be made in ZAM.

The flow we are striving to achieve is as follows
image

CHANGES TO ZAS

Since we are dependent on an OAuthClient generated outside of ZAM, changes need to be made to the app manifest.json file to enable the app to make use of it. The plan is to create two new custom hidden fields like the following

"parameters": [
  {
    "name": "bundle_token",
    "type": "bundle_oauth"
  },
  {
    "name": "bundle_integration_key",
    "type": "bundle_integration_key"
  }
]

Features

  • Both must exist together
  • Both fields are hidden
  • bundle_oauth
    ** This field will store the connection_uuid like the pre-existing oauth type
  • bundle_integration_key
    ** This field will store the integration key which is specified during the ZIS-Bundle upload (removing the need to rely on procedurally generated versions from ZAM)

For the most part, changes to this flow will remain the unchanged:
image

We will still query Zendesk App Market for the installation details and check if it is a ZIS App (here). Logic to identify if it utilizes ZIS-Connections needs to be altered to cater for the new connection_uuid and integration_key fields.

If those fields exist, we can go ahead and create the ZIS-Connections url without stitching up the integration key (i.e. app_market_XXX)

DONE WHEN

  • ZAS is able to validate both bundle_oauth and bundle_integration_key
  • Translations are ignored in this POC

@yoshdog
Copy link
Member

yoshdog commented Feb 25, 2020

It should be noted that although we are proposing this for our new Shopify integration on ZIS, it will ideally be the approach we would use for integrations built on ZIS that require an OAuth + Sidebar app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants