Master Data API - v2
# ATTENTION: **This version isn't compliant with data entities of old version (e.g. CL and AD). It's possible to use this configuration only to new data entities.** ## Welcome! VTEX Master Data is an easy-to-use, secure, fast, scalable and extensible repository. On it you can create your own Entities, store data and consult directly from the storefront or use it to store info for some external integration. There are internal VTEX modules that use VTEX Master Data as data repository. We have the VTEX Customer Service, VTEX Profile System and VTEX InStore, for example. It is also used by other internal services. There are two ways to use Master Data: 1. Directly from the storefront 2. External integration ### Directly from the storefront If your scenario is to be used inside the storefront, be aware of the following observations: 1. Use the storefront host to query or store information to avoid **CORS**; 2. Configure which information should be public and which shouldn't, inside the JSON Schema of the Data Entity; 3. Do not create query loops (the storefront may be affected with Throttling and apis may be turned off as a security protection); 4. Never add via JS any type of authentication key (x-vtex-api-appkey or x-vtex-api-apptoken); **It's important to avoid CORS using the relative path** ### External Integration If your scenario is to perform external integration, such as migrating client data from another service, be aware of the following observations: 1. Use the host ```{{accountName}}.vtexcommercestable.com.br```; 2. Use the authentication keys (x-vtex-api-appkey ou x-vtex-api-apptoken); ### Most used attributes listed here | Name | Description | | -------- | -------- | | accountName | Account name in VTEX License Manager | | name | Data Entity name | | schema | JSON Schema of a Data Entity | | id | Identifier of a document | | x-vtex-api-appKey | User key | | x-vtex-api-appToken | User token |
Description supplied by the publisher; it is a claim, not verified evidence.
- Name
- apisguru:vtex.local:Master-Data-API-
- Listed in
- APIs.guru
- Publisher
- vtex.local
- Latest version
- 1.0
- Published
- 2023-03-03
- Evidence
- Listed only, not analyzed yet
What a full analysis of Master Data API - v2 checks
Not checked yet. About 60 tools are analyzed every hour; each check links to its source when it runs:
- Publisher identity: not checked yet
- Repository ownership: not checked yet
- Organization verification: not checked yet
- Artifact provenance: not checked yet
- Source availability: not checked yet
- Version evidence: not checked yet
- Known vulnerabilities: not checked yet
- Install scripts: not checked yet
- Maintenance: not checked yet
- License: not checked yet
Before you install it
- Open the repository and confirm the account is the one you expect: look-alike names are common.
- Read what it asks for: files, accounts, network access and credentials it needs.
- Prefer a version from a verified publisher when one exists.