This page will help you get started with CSC 2QR (two QR code based flow) API.
Integration checklist
- API credentials are required:
client_id
client_secret
account_id
(for generatingaccount_token
)
- Base ZealiD (“Hermes”) backend URL is required:
- Testing environment: https://hermes-dev.zealid.com
- Production environment: https://core-hermes.zealid.com
- URL prefix to be added before CSC endpoints
- Current version: /api/v3.0/csc/v1/
- Separate ZealiD Android and iOS apps are to be used (they link to different environments and may have other environment-particular changes).
Summary of endpoints
Example of full testing URL (1st CSC endpoint) - no authorization needed: https://hermes-dev.zealid.com/api/v3.0/csc/v1/info
Example of oauth2/authorize
endpoint (note, parameters will need to be passed for URL to work): https://hermes-dev.zealid.com/api/v3.0/csc/v1/oauth2/authorize
Possible full flow call sequence:
- API call: POST
info
- Browser call: GET
authorize
withscope=service
(in user's browser) - API call: POST
oauth2/token
(to get access token) - API call: POST
credentials/list
- API call: POST
credentials/info
- Browser call: GET
authorize
withscope=credential
(in user's browser) - API call: POST
oauth2/token
(to get SAD - second token, forsignHash
) - API call: POST
signHash
- API call: POST
oauth2/revoke