# VTEX

Connect VTEX to your company operations. Review required fields, credential setup and how this connector works in Zild.

Source: https://zild.ai/en-US/docs/apps/zild-admin/connector-vtex

Connect VTEX to your company operations.

## Where to configure

Open Zild Admin → Integrations → Connectors, find the provider and use Configure or Edit. Enter the data from this guide, enable the connector for the workflow and save.

## Your company credentials

Customers must obtain and configure their own API keys or the authentication method required by this connector. The Zild subscription is based on company size; external service usage is billed separately by the respective provider. You do not need to configure connectors your operation does not use.

## Required fields

These requirements are the data needed by the workflow using the connector. Generic saving may accept empty fields that are only required when an operation runs. Saving does not confirm that the provider accepts the credential.



<table class="api-params"><thead><tr><th>Field</th><th>Workflow requirement</th></tr></thead><tbody><tr><td><code>Url</code></td><td>Your instance HTTPS API URL, including the required version prefix.</td></tr><tr><td><code>ApiKey</code></td><td>Account AppKey.</td></tr><tr><td><code>ApiSecret</code></td><td>AppToken; long tokens can also use CredentialsJson.AppToken.</td></tr></tbody></table>



## How to obtain credentials

- Generate an application key in VTEX Admin and assign only the roles required by the integration.
- Copy AppKey and AppToken when issued.
- Configure ApiKey, ApiSecret and the HTTPS URL for your VTEX account.

## How it works in Zild

Permissions are controlled by the roles assigned to the key.

## How to verify the configuration

After saving, use the matching workflow (query, agent, call or processing) to verify access. If it fails, check the credential, permissions and selected provider resource. For limited or legacy types, confirm availability with your administrator before use.

When editing, Zild displays protected credentials as asterisks. Preserve the masked value to keep the current credential or paste a new credential to replace it.

## Official documentation

- [VTEX: API keys](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)

[Back to Connectors](/en-US/docs/apps/zild-admin/integration)