Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added text for secure integration config
  • Loading branch information
usazqueueit authored May 11, 2020
1 parent c1abbc2 commit 78096f2
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions Documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,13 @@ The KnownUser library needs the Triggers and Actions to know which pages to prot
These Triggers and Actions are specified in the Go Queue-it self-service portal.

You should have a timer function, scheduled task, cron job or similar to download and cache the configuration for 5 - 10 minutes, so the configuration is ready when requests come in. You should NEVER download the configuration as part of the request handling.
You can find your configuration file here https://[your-customer-id].queue-it.net/status/integrationconfig/[your-customer-id] after a succesful publish. Remember, when you programmatically perform HTTP GET against the above endpoint then make sure you actually received the JSON data, i.e. only accept HTTP 200 with content-type application/json.
Please contact Queue-it support through the Go Queue-it self-service portal to get further help on this
You can find your configuration file here **https://[your-customer-id].queue-it.net/status/integrationconfig/[your-customer-id]** or via secure link (*) **https://[your-customer-id].queue-it.net/status/integrationconfig/secure/[your-customer-id]** after a successful publish. Remember, when you programmatically perform HTTP GET against the above endpoint then make sure you actually received the JSON data, i.e. only accept HTTP 200 with content-type application/json.
Please contact Queue-it support through the Go Queue-it self-service portal to get further help on this.

#### * How to download integration config with Api secrete Key:
Integration configuration contains valuable information like triggers and actions. Anyone can download the configuration by knowing the URL because it does not require any authentication. You can protect integration configurations by enabling the “**Secure integration config**” setting, so only legitimate systems can download it by providing a valid API key.

1. You need to enable “**Secure integration config**” setting in the Go Queue-it self-service portal.
2. You need to decorate the request by adding API key in the request header. You can get API key in the Go Queue-it self-service portal.

curl --request GET https://[your-customer-id].queue-it.net/status/integrationconfig/secure/[your-customer-id]' --header 'api-key: [Customer API-Key]'

0 comments on commit 78096f2

Please sign in to comment.