Skip to content

Commit

Permalink
Fixes out of date references in examples repo (#84)
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelfarrell76 authored Feb 19, 2023
1 parent c285f6d commit d8d41c9
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 10 deletions.
17 changes: 9 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,27 +54,28 @@ AUDIENCE="<TODO>"
### 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".

<img width="1386" alt="Screenshot 2023-02-19 at 2 00 52 PM" src="https://user-images.githubusercontent.com/10264973/219977722-8c15be4d-2508-4090-b06a-0fbfa55c2d7b.png">

- 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://<ORGANIZATION_URI>.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

Expand Down
7 changes: 7 additions & 0 deletions python/cron.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"

"""
Expand Down
14 changes: 12 additions & 2 deletions python/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit d8d41c9

Please sign in to comment.