Skip to main content

Zamn API

Note

The API integration with Zamn virtual rooms is only available in these plans: Advanced, Professional (5 rooms) and Professional + (10 rooms).

The API integration lets you connect your website or app to Zamn virtual rooms. The developers on your team program your website or app to talk to the rooms.

How to get the API key​

  1. From the dashboard, choose Settings.

  2. Go to Integrations.

  3. Click API.

    The Integrations page in Settings and the API card

  4. Click Regenerate.

    The API window and the Regenerate button

  5. A confirm window shows. Click OK.

    The browser confirm window and the OK button

    When the key is made, a success message shows.

  6. Click API again.

    The success message and the API card on the Integrations page

  7. Click the eye icon to show the key, then select it and copy it to use in your integration.

    The API Token field that holds the key, and the eye icon

Test the connection from the docs page (for developers)​

  1. Click API Docs.

    The API Docs link in the API window

  2. Go to the API Servers section.

  3. Type the subdomain of your platform in the SubDomain field.

    The API Servers section and the SubDomain field

  4. Go to the Authentication section.

  5. To sign in, paste the API key you copied into the field, then click SET.

    The Authentication section, the key field and the SET button

  6. Go to List Rooms, then click TRY.

    The List Rooms page and the TRY button

    The list of your rooms shows in the response.

    The request response with the list of rooms