Getting Started

Welcome to Prismm API! To begin integrating our powerful features, follow these steps:

1. Register for a Prismm Account

Visit Prismm Registration to create your Prismm account. Fill in the required information to complete the registration process.

2. Request Your Client Keys

After successful registration, request your Public Key and Private Key from Prismm. These keys will be securely sent to your registered email. Retain these keys as they are essential for secure API integration.

3. Connect Your Application’s Users to Prismm

To link user accounts between your application and Prismm, include the following HTML and JavaScript snippet on your webpage. This setup displays a login form for users to link their Prismm account to your application:

html

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>Connect to Prismm</title>
</head>
<body>
<button id="connect-to-prismm">Connect to Prismm</button>
<script>
  document.getElementById("connect-to-prismm").onclick = () => {
    window.open(
      "https://api.prismm.com/?appId=YOUR_PUBLIC_KEY",
      "Prismm Login",
      "height=600,width=800,left=10,top=10,resizable=yes,scrollbars=yes,toolbar=yes,menubar=no,location=no,directories=no,status=yes"
    );

    window.onmessage = (e) => {
      if (e.origin.endsWith("prismm.com")) {
        document.body.textContent = e.data.error ? `Error: ${e.data.error}` : `User ${e.data.user} has successfully logged in.`;
        // Store e.data.user as the userId for further API requests
      }
    };
  };
</script>
</body>
</html>

When users log in through this form, a unique userId will be returned to your application in e.data.user. This userId will be necessary for user-specific requests in the Prismm API. Further instructions on where to include the userId in API request payloads are provided on each API documentation page.

4. Secure API Requests with the Private Key

For each API request, include your Private Key in the Authorization header to ensure secure, authenticated access to Prismm API services.

Example Authorization Header:

Authorization: YOUR_PRIVATE_KEY

Replace YOUR_PRIVATE_KEY with the actual Private Key provided by Prismm.

5. Explore API Services

Once your account and integration are set up, refer to the API documentation to explore available services. Use the userId received from the login snippet and your Private Key to access various features, including occasion links, floorplans, and venue information.

Getting Started ​

1. Register for a Prismm Account ​

2. Request Your Client Keys ​

3. Connect Your Application’s Users to Prismm ​

4. Secure API Requests with the Private Key ​

Example Authorization Header: ​