{"templateId":"openapi_docs","sharedDataIds":{"openAPIDocsStore":"oas-apis/index.yaml","sidebar":"sidebar-sidebar.yaml__apis"},"props":{"definitionId":"apis/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/apis","seo":{"title":"Get Gift Cards","image":"/assets/understory-open-graph.85ea0c194bc643117a3256295b33fc48312b77ad89943893062f4c456d277f9d.9c1bb791.jpg","siteUrl":"https://developer.understory.io","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"itemId":"gift-card/getgiftcards","disableAutoScroll":true,"metadata":{"subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{"_partials/breaking-changes.md":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,2],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,2],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,2],"inline":true,"attributes":{"content":"Breaking changes are changes that can potentially break an integration."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":0},"end":{"line":2}}},{"$$mdtype":"Node","errors":[],"lines":[0,2],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":0},"end":{"line":2}}},{"$$mdtype":"Node","errors":[],"lines":[0,2],"inline":true,"attributes":{"content":"Below is a non-exhaustive list of what breaking changes could be."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":0},"end":{"line":2}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":0},"end":{"line":2}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":0},"end":{"line":2}}},{"$$mdtype":"Node","errors":[],"lines":[3,7],"inline":false,"attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","errors":[],"lines":[3,4],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[3,4],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[3,4],"inline":true,"attributes":{"content":"Removing an operation"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":3},"end":{"line":4}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":3},"end":{"line":4}}}],"type":"item","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":3},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[4,5],"inline":true,"attributes":{"content":"Renaming or removing a parameter, request, and/or response field"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":4},"end":{"line":5}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":4},"end":{"line":5}}}],"type":"item","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":4},"end":{"line":5}}},{"$$mdtype":"Node","errors":[],"lines":[5,7],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[5,6],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[5,6],"inline":true,"attributes":{"content":"Significantly changing the behavior of an endpoint, e.g., "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":5},"end":{"line":6}}},{"$$mdtype":"Node","errors":[],"lines":[5,6],"inline":true,"attributes":{"content":"POST /v1/bookings"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":5},"end":{"line":6}}},{"$$mdtype":"Node","errors":[],"lines":[5,6],"inline":true,"attributes":{"content":" changes from creating a booking to reserving seats at an event for later booking confirmation."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":5},"end":{"line":6}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":5},"end":{"line":6}}}],"type":"item","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":5},"end":{"line":7}}}],"type":"list","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":3},"end":{"line":7}}},{"$$mdtype":"Node","errors":[],"lines":[7,9],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[7,9],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[7,9],"inline":true,"attributes":{"content":"We will add new fields to the APIs and expect these to be consumed in a non-breaking fashion by your integration."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":7},"end":{"line":9}}},{"$$mdtype":"Node","errors":[],"lines":[7,9],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":7},"end":{"line":9}}},{"$$mdtype":"Node","errors":[],"lines":[7,9],"inline":true,"attributes":{"content":"This usually means configuring request/response serializers to accept unknown fields to avoid disruption."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":7},"end":{"line":9}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":7},"end":{"line":9}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":7},"end":{"line":9}}},{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{"content":"When a new version of the API is released, the previous API version is deprecated and will move into a grace period, where it will be "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}},{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{"content":"available for 6 months"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}}],"type":"strong","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}},{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{"content":"."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}},{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}},{"$$mdtype":"Node","errors":[],"lines":[10,12],"inline":true,"attributes":{"content":"During this grace period, you will need to migrate your integration to the new API versions to avoid service disruption."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/breaking-changes.md","start":{"line":10},"end":{"line":12}}}],"type":"document","annotations":[],"slots":{}},"_partials/generate-internal-integration-keys.md":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":"Sign in to Backoffice, click your profile in the lower left corner and click on Company settings."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":"Navigate to the "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"href":"https://backoffice.understory.io/settings/integrations"},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":"Integrations tab"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}}],"type":"link","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}},"redocly:::linkOriginal:href":"https://backoffice.understory.io/settings/integrations"},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":" in the menu."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":"At the bottom, you can create your integration, which is exactly what we are about to do."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[0,4],"inline":true,"attributes":{"content":"Click the \"Create your own integration\" bar."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":0},"end":{"line":4}}},{"$$mdtype":"Node","errors":[],"lines":[5,9],"inline":false,"attributes":{"alt":"Backoffice settings","src":"/assets/settings.789dee5d6ced7856fd0a89eba6f7ae5396263c74fb6a3731998f54b62280c154.0981bdac.png"},"children":[],"type":"tag","tag":"img","annotations":[{"type":"attribute","name":"alt","value":"Backoffice settings"},{"type":"attribute","name":"src","value":"/images/partials/generate-internal-integration-keys/settings.png"}],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":5},"end":{"line":9}},"redocly:::linkOriginal:src":"/images/partials/generate-internal-integration-keys/settings.png"},{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":true,"attributes":{"content":"Here you have a list of all the internal integration keys you have created."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":true,"attributes":{"content":"This is the place where you can view, update, and remove any keys in the future."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[10,13],"inline":true,"attributes":{"content":"The list is empty but we are about to change that."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":10},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[14,18],"inline":false,"attributes":{"alt":"Backoffice: Internal Integration Keys","src":"/assets/internal-integration-keys.fda6d03deefbe1371f290558eeb74322df0ebbf7c0b2c9cd0c7553c3510a645d.0981bdac.png"},"children":[],"type":"tag","tag":"img","annotations":[{"type":"attribute","name":"alt","value":"Backoffice: Internal Integration Keys"},{"type":"attribute","name":"src","value":"/images/partials/generate-internal-integration-keys/internal-integration-keys.png"}],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":14},"end":{"line":18}},"redocly:::linkOriginal:src":"/images/partials/generate-internal-integration-keys/internal-integration-keys.png"},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{"content":"Click the big \"Create new key\" button and choose a descriptive name."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{"content":"It is just for your reference so pick anything you will understand in the future."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{"content":"You also need to select at least one permission to continue."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{"content":"Let's select \"Read\" for \"Marketing consents\"."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[19,24],"inline":true,"attributes":{"content":"Now click \"Create\"."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":19},"end":{"line":24}}},{"$$mdtype":"Node","errors":[],"lines":[25,29],"inline":false,"attributes":{"alt":"Backoffice: New Internal Integration Keys","src":"/assets/new-key.a9512f5176b990c94bcc5bced4feadf910ef8138b03ed0ee6187f56ddb447358.0981bdac.png"},"children":[],"type":"tag","tag":"img","annotations":[{"type":"attribute","name":"alt","value":"Backoffice: New Internal Integration Keys"},{"type":"attribute","name":"src","value":"/images/partials/generate-internal-integration-keys/new-key.png"}],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":25},"end":{"line":29}},"redocly:::linkOriginal:src":"/images/partials/generate-internal-integration-keys/new-key.png"},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{"content":"That's it. You have created your very first integration keys."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{"content":"You must store these safely."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{"content":"The Client ID is OK to store in text, but the Secret Key will only ever be shown at this one time."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{"content":"Store it safely and don't share it."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[30,35],"inline":true,"attributes":{"content":"Anyone with this pair of information can access your Understory data."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":30},"end":{"line":35}}},{"$$mdtype":"Node","errors":[],"lines":[36,40],"inline":false,"attributes":{"alt":"Backoffice: Internal Integration Key ready","src":"/assets/key-ready.6d8f76dc70177d5368e22ee6ab3b9ddf671d00e94c6c003fdbc00d21d3b20b88.0981bdac.png"},"children":[],"type":"tag","tag":"img","annotations":[{"type":"attribute","name":"alt","value":"Backoffice: Internal Integration Key ready"},{"type":"attribute","name":"src","value":"/images/partials/generate-internal-integration-keys/key-ready.png"}],"slots":{},"location":{"file":"_partials/generate-internal-integration-keys.md","start":{"line":36},"end":{"line":40}},"redocly:::linkOriginal:src":"/images/partials/generate-internal-integration-keys/key-ready.png"}],"type":"document","annotations":[],"slots":{}},"_partials/use-internal-integration-keys.md":{"$$mdtype":"Node","errors":[],"lines":[],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[0,7],"inline":false,"attributes":{"file":"./samples/oauth2-client-credentials.sh","language":"sh","title":"Get access token with internal integration key","from":0,"to":8,"rawContent":"clientId=\"<client-id>\"\nclientSecret=\"<secret-key>\"\nscopes=\"openid marketing.read\"\n\ncurl -X POST https://api.auth.understory.io/oauth2/token \\\n    -H \"User-Agent: My-Company/Marketing-Automation-App\" \\\n    -H \"Content-Type: application/x-www-form-urlencoded\" \\\n    -d \"grant_type=client_credentials&scope=$scopes&audience=https://api.understory.io&client_id=$clientId&client_secret=$clientSecret\""},"children":[],"type":"tag","tag":"code-snippet","annotations":[{"type":"attribute","name":"file","value":"./samples/oauth2-client-credentials.sh"},{"type":"attribute","name":"language","value":"sh"},{"type":"attribute","name":"title","value":"Get access token with internal integration key"},{"type":"attribute","name":"from","value":0},{"type":"attribute","name":"to","value":8}],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":0},"end":{"line":7}}},{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[8,9],"inline":true,"attributes":{"content":"You need to provide the following fields in the body of the HTTP request."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":8},"end":{"line":9}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":8},"end":{"line":9}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":8},"end":{"line":9}}},{"$$mdtype":"Node","errors":[],"lines":[10,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":true,"attributes":{"content":"Field"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"strong","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"th","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}},{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","errors":[],"lines":[10,11],"inline":true,"attributes":{"content":"Value"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"strong","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"th","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}}],"type":"thead","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":11}}},{"$$mdtype":"Node","errors":[],"lines":[12,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":true,"attributes":{"content":"grant_type"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":true,"attributes":{"content":"Literal string "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[12,13],"inline":true,"attributes":{"content":"client_credentials"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":13}}},{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":true,"attributes":{"content":"audience"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}},{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":true,"attributes":{"content":"Literal string "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}},{"$$mdtype":"Node","errors":[],"lines":[13,14],"inline":true,"attributes":{"content":"https://api.understory.io"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":13},"end":{"line":14}}},{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":true,"attributes":{"content":"scope"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}},{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[14,15],"inline":true,"attributes":{"content":"Applicable space seperated scopes"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":14},"end":{"line":15}}},{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":true,"attributes":{"content":"client_id"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}},{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[15,16],"inline":true,"attributes":{"content":"Client ID"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":15},"end":{"line":16}}},{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":true,"attributes":{"content":"client_secret"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}},{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[16,17],"inline":true,"attributes":{"content":"Secret key"},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"td","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"tr","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":16},"end":{"line":17}}}],"type":"tbody","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":12},"end":{"line":17}}}],"type":"table","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":10},"end":{"line":17}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":false,"attributes":{},"children":[{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{"content":"The response will contain your time-limited access token."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{"content":"Notice the "},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{"content":"expires_in"},"children":[],"type":"code","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{"content":" field that contains the number of seconds the token is valid."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{},"children":[],"type":"softbreak","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[18,21],"inline":true,"attributes":{"content":"In this case, it expires in 3599 seconds or just short of 1 hour."},"children":[],"type":"text","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}}],"type":"inline","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}}],"type":"paragraph","annotations":[],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":18},"end":{"line":21}}},{"$$mdtype":"Node","errors":[],"lines":[22,28],"inline":false,"attributes":{"file":"./samples/oauth2-client-credentials.sh","language":"json","title":"Access token","from":10,"rawContent":"{\n  \"access_token\": \"eyJhbGciOiJSUzI1NiIsImtpZCI6ImZhNTc3YmE0LTk5MmQt(...)\",\n  \"expires_in\": 3599,\n  \"scope\": \"openid marketing.read\",\n  \"token_type\": \"bearer\"\n}\n"},"children":[],"type":"tag","tag":"code-snippet","annotations":[{"type":"attribute","name":"file","value":"./samples/oauth2-client-credentials.sh"},{"type":"attribute","name":"language","value":"json"},{"type":"attribute","name":"title","value":"Access token"},{"type":"attribute","name":"from","value":10}],"slots":{},"location":{"file":"_partials/use-internal-integration-keys.md","start":{"line":22},"end":{"line":28}}}],"type":"document","annotations":[],"slots":{}}},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"developer.understory.io","port":4000,"ipAddress":"216.73.216.71"},"lang":"default_locale","env":{"PUBLIC_INTERCOM_ID":"bo8t1wpq","PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/apis/gift-card/getgiftcards","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}