Get a signed preview link (about 6 hours) to show the person the site before publishing.

GEThttps://app.softsolz.uk/api/v1/services/site-builder/projects/{id}/preview

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Query Params

pagestring

Page to open, default index.html.

Response

Response Body

urlstringAbsolute signed URL to open in a browser.

pagestringPage the URL opens.

expires_atstringWhen the link stops working.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.siteBuilder.getProjectPreview('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "url": "string",
    "page": "string",
    "expires_at": "string"
  }
}