Skip to content

Latest commit

 

History

History
167 lines (139 loc) · 8.56 KB

README.md

File metadata and controls

167 lines (139 loc) · 8.56 KB
Raw

Sessions

(vault.sessions)

Overview

Available Operations

create

Making a POST request to this endpoint will initiate a Hosted Vault session. Redirect the consumer to the returned URL to allow temporary access to manage their integrations and settings.

Note: This is a short lived token that will expire after 1 hour (TTL: 3600).

Example Usage

import { Apideck } from "@apideck/unify";

const apideck = new Apideck({
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
  const result = await apideck.vault.sessions.create({
    consumerMetadata: {
      accountName: "SpaceX",
      userName: "Elon Musk",
      email: "elon@musk.com",
      image: "https://www.spacex.com/static/images/share.jpg",
    },
    redirectUri: "https://mysaas.com/dashboard",
    settings: {
      unifiedApis: [
        "crm",
      ],
      sessionLength: "30m",
    },
    theme: {
      favicon: "https://res.cloudinary.com/apideck/icons/intercom",
      logo: "https://res.cloudinary.com/apideck/icons/intercom",
      primaryColor: "#286efa",
      sidepanelBackgroundColor: "#286efa",
      sidepanelTextColor: "#FFFFFF",
      vaultName: "Intercom",
      privacyUrl: "https://compliance.apideck.com/privacy-policy",
      termsUrl: "https://www.termsfeed.com/terms-conditions/957c85c1b089ae9e3219c83eff65377e",
    },
    customConsumerSettings: {
      "feature_flag_1": true,
      "tax_rates": [
        {
          "id": "6",
          "label": "6%",
        },
        {
          "id": "21",
          "label": "21%",
        },
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { ApideckCore } from "@apideck/unify/core.js";
import { vaultSessionsCreate } from "@apideck/unify/funcs/vaultSessionsCreate.js";

// Use `ApideckCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const apideck = new ApideckCore({
  apiKey: process.env["APIDECK_API_KEY"] ?? "",
  consumerId: "test-consumer",
  appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX",
});

async function run() {
  const res = await vaultSessionsCreate(apideck, {
    consumerMetadata: {
      accountName: "SpaceX",
      userName: "Elon Musk",
      email: "elon@musk.com",
      image: "https://www.spacex.com/static/images/share.jpg",
    },
    redirectUri: "https://mysaas.com/dashboard",
    settings: {
      unifiedApis: [
        "crm",
      ],
      sessionLength: "30m",
    },
    theme: {
      favicon: "https://res.cloudinary.com/apideck/icons/intercom",
      logo: "https://res.cloudinary.com/apideck/icons/intercom",
      primaryColor: "#286efa",
      sidepanelBackgroundColor: "#286efa",
      sidepanelTextColor: "#FFFFFF",
      vaultName: "Intercom",
      privacyUrl: "https://compliance.apideck.com/privacy-policy",
      termsUrl: "https://www.termsfeed.com/terms-conditions/957c85c1b089ae9e3219c83eff65377e",
    },
    customConsumerSettings: {
      "feature_flag_1": true,
      "tax_rates": [
        {
          "id": "6",
          "label": "6%",
        },
        {
          "id": "21",
          "label": "21%",
        },
      ],
    },
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter Type Required Description
request components.Session ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.VaultSessionsCreateResponse>

Errors

Error Type Status Code Content Type
errors.BadRequestResponse 400 application/json
errors.UnauthorizedResponse 401 application/json
errors.PaymentRequiredResponse 402 application/json
errors.NotFoundResponse 404 application/json
errors.UnprocessableResponse 422 application/json
errors.APIError 4XX, 5XX */*