EDU-17778 Configuring an external Gift Card Provider#2620
Conversation
👁️🗨️ Preview changes on Developer PortalYou can use the link below to load the Developer Portal in preview mode with the changes from this branch: Below is the list of modified pages and their corresponding preview URLs:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
|
|
||
| In this guide, you will learn how to: | ||
|
|
||
| - [Register the Gift Card Provider in VTEX](#step-1-register-the-gift-card-provider-in-vtex) |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD051/link-fragments Link fragments should be valid [Context: "Register the Gift Card Provider in VTEX"]
| In this guide, you will learn how to: | ||
|
|
||
| - [Register the Gift Card Provider in VTEX](#step-1-register-the-gift-card-provider-in-vtex) | ||
| - [Confirm the provider registration](#step-2-confirm-the-provider-registration) |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD051/link-fragments Link fragments should be valid [Context: "Confirm the provider registration"]
|
|
||
| - [Register the Gift Card Provider in VTEX](#step-1-register-the-gift-card-provider-in-vtex) | ||
| - [Confirm the provider registration](#step-2-confirm-the-provider-registration) | ||
| - [Implement the provider protocol endpoints](#step-3-implement-the-provider-protocol-endpoints) |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD051/link-fragments Link fragments should be valid [Context: "Implement the provider protocol endpoints"]
|
|
||
| Use the [Create or update gift card provider](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-) endpoint to register or update a provider in VTEX. | ||
|
|
||
| __PUT - Update gift card provider__ |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD036/no-emphasis-as-heading Emphasis used instead of a heading [Context: "PUT - Update gift card provide..."]
|
|
||
| Use the [Create or update gift card provider](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-) endpoint to register or update a provider in VTEX. | ||
|
|
||
| __PUT - Update gift card provider__ |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD050/strong-style Strong style [Expected: asterisk; Actual: underscore]
|
|
||
| After registering the provider, use the [List all gift card providers](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders) endpoint to confirm that the configuration is available in the VTEX account. | ||
|
|
||
| __GET - List all gift card providers__ |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD050/strong-style Strong style [Expected: asterisk; Actual: underscore]
|
|
||
| After registering the provider, use the [List all gift card providers](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders) endpoint to confirm that the configuration is available in the VTEX account. | ||
|
|
||
| __GET - List all gift card providers__ |
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD050/strong-style Strong style [Expected: asterisk; Actual: underscore]
| - [Cancel a gift card transaction](https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol#post-/giftcards/-giftCardId-/transactions/-transactionId-/cancellations) (`POST /giftcards/{giftCardId}/transactions/{transactionId}/cancellations`) | ||
|
|
||
| > ⚠️ All provider protocol endpoints must accept `application/vnd.vtex.giftcards.v1+json` as the media type. For `POST` requests, VTEX sends this value in both `Accept` and `Content-Type`. For `GET` requests, VTEX sends it in `Accept`. | ||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD028/no-blanks-blockquote Blank line inside blockquote
| > ⚠️ All provider protocol endpoints must accept `application/vnd.vtex.giftcards.v1+json` as the media type. For `POST` requests, VTEX sends this value in both `Accept` and `Content-Type`. For `GET` requests, VTEX sends it in `Accept`. | ||
|
|
||
| > ⚠️ The provider server must also accept additional VTEX headers, such as `<ul>` `<li>` `content-length`: body size in bytes (only in POSTs)`</li>` `<li>` `x-vtex-operation-id`: Internal operation UUID `</li>` `<li>` `x-vtex-debug-id`: Debug ID (may have an empty value) `</li>` `<li>` `traceparent`: W3C distributed tracing header `</li>` `<li>` `baggage`: tracking metadata `</li>` `</li>` `accept-encoding`: gzip `</li>` `</ul>`. | ||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD028/no-blanks-blockquote Blank line inside blockquote
| This request creates the transaction that reserves or debits the gift card amount. In the response, return a unique transaction `id`. | ||
|
|
||
| > ⚠️ VTEX uses this value as `{transactionId}` in settlement and cancellation URLs. The provider must store and recognize this identifier in subsequent requests. | ||
|
|
There was a problem hiding this comment.
[markdownlint] reported by reviewdog 🐶
MD028/no-blanks-blockquote Blank line inside blockquote
|
|
||
| Use the [Create or update gift card provider](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#put-/api/giftcardproviders/-giftCardProviderId-) endpoint to register or update a provider in VTEX. | ||
|
|
||
| __PUT - Update gift card provider__ |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| __PUT - Update gift card provider__ | |
| **PUT - Update gift card provider** |
|
|
||
| After registering the provider, use the [List all gift card providers](https://developers.vtex.com/docs/api-reference/giftcard-hub-api#get-/api/giftcardproviders) endpoint to confirm that the configuration is available in the VTEX account. | ||
|
|
||
| __GET - List all gift card providers__ |
There was a problem hiding this comment.
[markdownlint-fix] reported by reviewdog 🐶
| __GET - List all gift card providers__ | |
| **GET - List all gift card providers** |
1 participant
Summary
EDU-17778 Configuring an external Gift Card Provider
Type of change
Checklist
AI review instructions
This repository supports automated AI reviews for Markdown files in the
docsfolder, exceptdocs/localization.To run reviews on this PR, add at least one of the following labels:
AI style review: evaluates tone and adherence to VTEX style guidelines.AI grammar review: identifies grammar and spelling issues.Once at least one label is added, the review(s) will run automatically.
After the review is completed, the corresponding label will be removed and the label
AI reviewedwill be added to the PR.Note
To rerun a review, remove and add the desired label again.