vtex.local

Welcome! The License Manager API allows you to create users, modify their names and emails, as well as add and remove roles from users. ATTRIBUTES |Attribute name | Description | |:------------|--------------| |accountName | Account name in VTEX License Manager | |environment | En

🔑 apikey 12 endpoints

📄 Docs 📋 OpenAPI spec 🔬 Try in Swagger UI

SDKs by language (10 total)

lever-sdk ✓ Official

npm install lever-sdk

GitHub integration →

ads-js ✓ Official

npm install ads-js

GitHub integration →

vtex-node-sdk

npm install vtex-node-sdk

GitHub integration →

physical-payments-sdk ✓ Official

# Maven: see https://github.com/vtex-apps/physical-payments-sdk

GitHub integration →

VTEX-SDK-dotnet

dotnet add package VTEX-SDK-dotnet

GitHub integration →

vtex-sdk

composer require vtex-sdk

GitHub integration →

vtex-sdk-php

composer require vtex-sdk-php

GitHub integration →

vtex-api

composer require vtex-api

GitHub integration →

vtex-kotlin-sdk

# See https://github.com/ksetoue/vtex-kotlin-sdk

GitHub integration →

vtex.js ✓ Official

# See https://github.com/vtex/vtex.js

GitHub integration →

curl examples

Get information about account

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/vlm/account

Get appKeys from account

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/vlm/appkeys

Get Stores

curl \
  -H "X-VTEX-API-AppKey: $API_KEY" \
  https://vtex.local/api/vlm/account/stores

Endpoints (12 total)

GET

/api/vlm/account

Get information about account

GET

/api/vlm/appkeys

Get appKeys from account

GET

/api/vlm/account/stores

Get Stores

GET

/api/license-manager/users/{userId}

Get User

GET

/api/license-manager/users/{userId}/roles

Get Roles by User/appKey

GET

/api/license-manager/site/pvt/roles/list/paged

Get List of Roles

GET

/api/license-manager/site/pvt/logins/list/paged

Get List of Users

POST

/api/vlm/appkeys

Create new appkey

POST

/api/license-manager/users

Create User

PUT

/api/vlm/appkeys/{id}

Update appkey

PUT

/api/license-manager/users/{userId}/roles

Put Roles in User/appKey

DELETE

/api/license-manager/users/{userId}/roles/{roleId}

Remove Role from User/appKey