2022 Q3: Merchant integration

• 1. Summary
• 2. Details
  • 2.1 Before
  • 2.2 After
  • 2.3 API key management
    • 2.3.1 Create API key
    • 2.3.2 Update API key
  • 2.4 SSO client management
    • 2.4.1 Create SSO client
    • 2.4.2 Update SSO client
• 3. Release plan

---

1. Summary

Setel merchant ops can manage API keys and SSO client through Setel Admin Portal

2. Details

2.1 Before

When merchant need to use Setel services, product managers need to create an ACCESS ticket to request Engineering Setel Auth Maintainers to generate the API key or SSO client for the merchant. Then the product managers will documents the generated info and share it to the relevant parties.

2.2 After

Merchant ops can manage API keys and SSO clients in merchant detail page under Clients section. This feature can simplify the process of managing API key and SSO client, as well as reduce the risk of documentation error.

2.3 API key management

API key allows merchant to access to Setel system via backend API call.

2.3.1 Create API key

	Steps	Notes	Screenshot
1	Assign groups to the API key then click Save	Dropdown items: [WIP] Setel Admin: API key groups
2	Share Client ID and Client secret to the merchant	Client secret will be hidden after leaving/ refreshing the page. The only way to retrieve again is to reset the Client secret and get a new secret. Merchant can refer to https://developer.setel.com/docs on integrating with Setel APIs.

2.3.2 Update API key

	Features	Description	Screenshot
1	Edit client	Admin user can edit API key name and groups, as well as delete the API key in the edit modal.
2	Reset client secret	Admin user can reset the Client secret and get a new secret.
3	Disable/Enable client	Admin user can temporary blocks merchant access to Setel system by disabling the client. The system access can be reinstated by enabling back the client.

2.4 SSO client management

After creating a SSO client, merchant can use Setel Connect: Web Form to authenticate customers using their Setel account.

2.4.1 Create SSO client

The following information need to get from the merchant:

	Fields	Description	Setel Connect Form
1	Third party	Identify the merchant is first party (e.g. PRYSM) or third party (e.g. iPay88). Setel needs customer consent through Setel Connect: Consent for third party merchants to get user info.
2	Redirect URI	The list of web link to redirect once customer has successfully login through Setel Connect.
3	Icon URI	The image link to display merchant icon on Setel Connect Form.
4	Show banner	To show or hide the banner which contains the icon.

	Steps	Notes	Screenshot
1	Create SSO client	Dropdown items: [WIP] Setel Admin: SSO client scopes
2	Share Client ID and Client secret to the merchant	Client secret will be hidden after leaving/ refreshing the page. The only way to retrieve again is to reset the Client secret and get a new secret. Merchant can refer to https://developer.setel.com/docs on using Setel SSO client.

2.4.2 Update SSO client

	Features	Description	Screenshot
1	Edit client	Admin user can edit all SSO client fields, as well as delete the SSO client in the edit modal.
2	Reset client secret	Admin user can reset the Client secret and get a new secret.
3	Disable/Enable client	Admin user can temporary blocks merchant access to Setel system by disabling the client. The system access can be reinstated by enabling back the client.

3. Release plan

The merchant integration is targeted to be released on 1.106.0 26 Sep 2022