External API

Storylane now offers External API capabilities designed for advanced users, enabling seamless backend integration with our platform. These APIs provide enhanced functionality to help you streamline your demo management and improve security.

The API is available to users on the Enterprise plan. If you're interested in testing the API or the Enterprise plan, please contact us at [e-mail].

Benefits of External API Integration

• Access Published Demos: List and track all published demos effortlessly.

• Secure Demo Links: Generate demo links with advanced security features like passcodes, expiration dates, and authentication codes.

• Personalization: Pass email parameters in demo links for tailored experiences.

• Token Management: Update links with secure access tokens.

• Control Access: View active links and disable them as required.

Getting Started

To begin using the External API, you’ll need to request an API token from Storylane. Follow the steps below:

Step 1: Request an API Token and Workspace ID

1. Contact our support team at [e-mail] to request the following credentials:

   • workspace_id – Unique identifier for your workspace.

   • access_token – Your secure API access token.

2. Once your request is approved, you will receive both credentials securely.

3. Save these credentials securely, as they are required for authenticated API requests.

We are not able to access access_token again if you lose it. We don’t store it on our side and have no access to it after we send it to you. Therefore, please store it securely.

Step 2: Set Up and Authenticate Using Postman

• Access the Storylane Public Postman Collection: Storylane Public Postman Collection.
• In the Postman collection, locate and replace the following variables:

  • WORKSPACE_ID – Replace with the workspace ID provided by support.

  • ACCESS_TOKEN(The Bearer Auth Token) – Replace with the API token provided by support.

Step 3: Run and Verify the Data

Run the API endpoints in Postman and verify that you are successfully retrieving your company’s demo data.

Here is an interactive demo demonstrating how to set up using Postman 👇

API Responses

1. All Published Demos Use the endpoint to list all published demos in your workspace. A sample response:

{
    "demos": [
        {
            "id": "a85dfc8f-f930-4a91-813c-35429711f311",
            "edited_at": "2025-01-08T08:04:52.238-12:00",
            "folder_id": null,
            "kind": "html",
            "links_count": 1,
            "name": "Storylane Test 1",
            "published_at": "2024-12-30T03:04:30.124-12:00",
            "status": "amended",
            "team_id": "23ba72ac-1bd8-4ca8-889e-1db880c74b4f"
        },
        {
            "id": "180b0bfd-c80b-4bf3-af00-c5dae64914c8",
            "edited_at": "2025-01-08T07:25:02.910-12:00",
            "folder_id": null,
            "kind": "image",
            "links_count": 1,
            "name": "Storylane Test 2",
            "published_at": "2025-01-08T05:51:56.965-12:00",
            "status": "amended",
            "team_id": "23ba72ac-1bd8-4ca8-889e-1db880c74b4f"
        },
        ...
    ]
}

---

2. Get Details on a Single Demo Use the endpoint to fetch detailed information about a specific demo. A sample response:

{
    "demo": {
        "id": "a85dfc8f-f930-4a91-813c-35429711f311",
        "chapters": [
            {
                "id": "df2d252f-c57c-4cc5-91e6-1d40e7e1ad95",
                "name": "Default",
                "steps": [
                    {
                        "id": "0c6c8150-8fb8-4413-bf91-3337c1a3e962",
                        "audio_url": "",
                        "content": "<h2 style=\"text-align: center\">How to Set Up and Authenticate Using Postman</h2>",
                        "cta": "Start Tour",
                        "kind": "popup",
                        "secondary": null,
                        "transcription": null
                    },
                    {
                        "id": "b6e9abbd-dcce-4358-9687-994841fdc3de",
                        "audio_url": "",
                        "content": "<p>Move the Storylane public collection to your private collection by creating a fork.</p>",
                        "cta": null,
                        "kind": "hotspot",
                        "secondary": null,
                        "transcription": null
                    }
                ]
            }
        ],
        "checklist": null,
        "convert_cta": "Talk to Sales",
        "edited_at": "2025-01-10T03:51:39.498-12:00",
        "folder_id": null,
        "kind": "image",
        "links_count": 1,
        "name": "How to Set Up and Authenticate Using Postman",
        "published_at": "2025-01-10T03:51:39.498-12:00",
        "status": "published",
        "team_id": "23ba72ac-1bd8-4ca8-889e-1db880c74b4f"
    }
}

---

3. List Demo Links Returns a response containing all links associated with a specific demo. A sample:

{
    "links": [
        {
            "id": "00fd70af-7f24-4f10-b7f1-d382cc492276",
            "default_link": true,
            "email_confirmation_required": false,
            "email_required": false,
            "expires_at": null,
            "name": "Default",
            "passcode": null,
            "url": "https://app.storylane.io/share/jkzyb2hwbamc",
            "whitelist_email_domains": []
        }
    ]
}

---

4. Create a New Demo Link A sample response for getting the details of newly created demo links:

{
    "link": {
        "id": "ca7ea033-b6fe-4168-8a9c-09b8b8f5132a",
        "default_link": false,
        "email_confirmation_required": false,
        "email_required": false,
        "expires_at": null,
        "name": "Unit",
        "passcode": null,
        "url": "https://app.storylane.io/share/v78xg9uate6b",
        "whitelist_email_domains": []
    }
}

---

5. Update an Existing Demo Link Returns a response with updated details of an existing demo link:

{
    "link": {
        "id": "ca7ea033-b6fe-4168-8a9c-09b8b8f5132a",
        "default_link": false,
        "email_confirmation_required": false,
        "email_required": false,
        "expires_at": null,
        "name": "fresh-thinking",
        "passcode": null,
        "url": "https://app.storylane.io/share/v78xg9uate6b",
        "whitelist_email_domains": []
    }
}

Additional Notes

• Ensure API tokens are stored securely and not shared publicly.

For further assistance, please contact [e-mail].