Skip to content

Commit 1ffccdf

Browse files
authored
Merge pull request #15 from usazqueueit/patch-1
Update README.md
2 parents e52335f + c72e34d commit 1ffccdf

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

Documentation/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,18 @@ The KnownUser library needs the Triggers and Actions to know which pages to prot
77
These Triggers and Actions are specified in the Go Queue-it self-service portal.
88

99
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.
10-
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.
10+
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.
1111
Please contact Queue-it support through the Go Queue-it self-service portal to get further help on this.
1212

13+
### * How to download integration config with Api secrete Key:
14+
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.
15+
16+
1. You need to enable “**Secure integration config**” setting in the Go Queue-it self-service portal.
17+
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.
18+
19+
curl --request GET https://[your-customer-id].queue-it.net/status/integrationconfig/secure/[your-customer-id]' --header 'api-key: [Customer API-Key]'
20+
21+
1322
![Configuration Provider flow](https://github.com/queueit/KnownUser.V3.PHP/blob/master/Documentation/ConfigProviderExample.png)
1423

1524

0 commit comments

Comments
 (0)