Session Manager API
This documentation goes in detail how to interact with Session Manager's API. For a more top-level approach, check the [design…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This documentation goes in detail how to interact with Session Manager's API. For a more top-level approach, check the design documentation.
Endpoints 4
Sessions
- GETGet Session
/sessions?items=namespace1.key1,namespace2.key2Items are the keys of the values you wish to get. It follows the format namespace1.key1,namespace2.key2. So if you wish to recover the data sent on the… - POSTCreate new session
/sessionsThe response should contain a session cookie. Further POST or PATCH requests will edit the existing session rather than creating a new one. All parameters in… - PATCHEdit session
/sessionsThis works exactly the same as the POST create session, but when the request is sent with a vtex_session cookie, it retrieves the session first and then…
Segment
- GETGet Segment
/segmentsYou can add certain public fields in the query string and the system will attempt to fulfill it. Values such as cultureInfo and utm are overwriteable, just…
API details
- Base URL
https://vtex.localhttps://{accountName}.{environment}.com.br/api- Authentication
- An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header - Operations
- 4 operations on 2 pathsGET 2POST 1PATCH 1
- Main resources
- Sessions 3Segment 1
- Description format
- OpenAPI 3.0.0, API version
1.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Session Manager API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Session Manager API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Get Session” (GET /sessions?items=namespace1.key1,namespace2.key2), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Session Manager API?
This documentation goes in detail how to interact with Session Manager's API. For a more top-level approach, check the [design… It is listed under Other and has 4 endpoints.
Who publishes the Session Manager API?
It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Session Manager API?
Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br/api. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the Session Manager API?
It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.
How many endpoints does the Session Manager API have?
4 operations on 2 paths (2 GET, 1 POST, 1 PATCH). The largest groups are Sessions, Segment.
Is forking the Session Manager API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.