Embed Tokens

APIs to share maps securely

Embed tokens enable safely sharing your private maps.

With these APIs, you can generate secure tokens for embedding maps.

Create an Embed Token

post

Creates a short-lived (15 minutes) token for authenticating a visitor to view a private embedded map view without being logged into Felt. You must provide a user_email to associate the token with the end user that will be viewing the map. Each end user should be a member of your Felt workspace with a viewer, editor, or admin role assigned.

Usage

• Generate a token by making a call to this API from your server

• Securely pass the token to your frontend client

• Include the token as a query parameter on the Embed URL in an iframe

<iframe src="https://felt.com/embed/map/{mapId}?token={token}"></iframe>

Enabling Layer Export

You can allow EmbedToken based page views to export layer data.

• Turn on "Viewer permissions: Export data" in Map settings

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

map_idstringRequired

Query parameters

user_emailstringRequired

Each token must be associated with the email address of the user who will use it.

Responses

200

EmbedToken

application/json

401

UnauthorizedError

application/json

403

UnauthorizedError

application/json

404

NotFoundError

application/json

422

Unprocessable Entity

application/json

429

Unprocessable Entity

application/json

500

InternalServerError

application/json

post

/api/v2/maps/{map_id}/embed_token

HTTPcURLJavaScriptPython

POST /api/v2/maps/{map_id}/embed_token?user_email=text HTTP/1.1
Host: felt.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "expires_at": "2024-05-25T15:51:34",
  "token": "text"
}