diff --git a/README.md b/README.md index c76e265..0b58632 100644 --- a/README.md +++ b/README.md @@ -54,27 +54,28 @@ AUDIENCE="" ### TRANSCEND_API_KEY This API key authenticates you to Transcend, and you can generate it on the [admin dashboard](https://app.transcend.io/settings#Developer). -API keys must be scoped to certain operations or data silos. +API keys must be scoped to the proper integration that you are responding to. ### SOMBRA_API_KEY This API key authenticates you to to your Sombra gateway. -- If you're using multi-tenant Sombra (most common) you don't need to set this. +- If you're using "Transcend Hosted - Multi Tenant" Sombra (most common) you don't need to set this. - If you are self-hosting Sombra, you would have generated this at the time of setup and stored it securely. -- If Transcend is hosting the gateway on your behalf in a single-tenant instance, you will receive this via a secure channel. +- If Transcend is hosting the gateway on your behalf in a single-tenant instance, you should reach out to your account manager to get this key. + +You can see which version of the Sombra Gateway you are using by visiting [Infrastructure -> Sombra](https://app.transcend.io/infrastructure/sombra/sombras) settings in the Admin Dashboard. ### SOMBRA_URL -This is the URL of your Sombra gateway. +This is the URL of your Sombra gateway. You can find your URL by visiting [Infrastructure -> Sombra](https://app.transcend.io/infrastructure/sombra/sombras) settings in the Admin Dashboard. This URL is the value titled "CUSTOMER INGRESS URL". + +Screenshot 2023-02-19 at 2 00 52 PM -- If you're using multi-tenant Sombra (most common), this is `https://multi-tenant.sombra.transcend.io`. -- If you are self-hosting Sombra, you assign this value. -- If Transcend is hosting the gateway on your behalf in a single-tenant instance, this is `https://.sombra.transcend.io`. ### Audience -This is the audience that you will verify is set on the incoming JWT. You can find your Organization URI at https://app.transcend.io/settings, which is used as the Audience field. +This is the audience that you will verify is set on the incoming Json Web Tokens (JWTs). You can find your Sombra audience under [Infrastructure -> Sombra](https://app.transcend.io/infrastructure/sombra/sombras) in the Admin Dashboard. This URL is the value titled "SOMBRA AUDIENCE". ## Languages diff --git a/python/cron.py b/python/cron.py index 0b32f16..89dd215 100644 --- a/python/cron.py +++ b/python/cron.py @@ -21,6 +21,13 @@ headers = { "Authorization": "Bearer " + TRANSCEND_API_KEY, } + +""" +URL of your Sombra Gateway. +You can find this value under "Customer Ingress URL" +under your Infrastructure -> Sombra settings +https://app.transcend.io/infrastructure/sombra/sombras +""" SOMBRA_URL = "https://multi-tenant.sombra.transcend.io" """ diff --git a/python/main.py b/python/main.py index 91b460e..7f3e421 100644 --- a/python/main.py +++ b/python/main.py @@ -24,7 +24,12 @@ # The API to use with the sombra instance that encrypts the data before hitting Transcends servers THIS IS A SECRET, STORE SAFELY AND CYCLE REGULARLY SOMBRA_API_KEY = os.environ.get('SOMBRA_API_KEY') -# The url of the sombra instance +""" +URL of your Sombra Gateway. +You can find this value under "Customer Ingress URL" +under your Infrastructure -> Sombra settings +https://app.transcend.io/infrastructure/sombra/sombras +""" SOMBRA_URL = os.environ.get('SOMBRA_URL', 'https://multi-tenant.sombra.transcend.io') # The url to respond to webhooks with @@ -33,7 +38,12 @@ # Whether to verify the JWT from Transcend, set to False to trust the JWT always VERIFY_JWT = True -# The audience on the JWT to verify. You can find your Organization URI at https://app.transcend.io/infrastructure/sombra, which is the audience +""" +The audience used to verify Json Web Tokens (JWTs) +You can find this value under "Sombra Audience" +under your Infrastructure -> Sombra settings +https://app.transcend.io/infrastructure/sombra/sombras +""" AUDIENCE = os.environ.get('AUDIENCE') # Whether to trust self signed certs