Call API Endpoint

2 min

Below are the details of the API endpoint that needs to be called in order to receive the embedLocation, which will be used to embed in the iframe. initialized hgjhgi wdwedwe

Call Autoscriber Endpoint

POST

https://io.autoscriber.com/v1/embed

An example of the API (also see on the right panel) is as follows:

{
  "priority": "1",
  "billingReference": "EHRName",
  "userId": "user123",
  "config": {
    "webhook": {
      "url": "https://example.com/webhook",
      "headers": {"Authorization": "Bearer your_token_here"}
    },
    "displayName": "Jane Doe",
    "gender": "female",
    "specialty": "gp",
    "preferredMicrophone": "device_id_1234",
    "preferred_languages": "nl",
    "languages": ["en", "nl"],
    "templates": ["standard_en"], 
    "sortTemplates": "false",
    "editing": ["true"],
    "crossOriginTarget": "https://parent.example.com",
    "theme": {
      "primaryColor": "#FF5733"
    },
    "exitAfterSync": true,    
    "askConsent": true,
    "newTemplate": true,
    "toggleCodes": true,
    "coding_systems": ["SNOMED_CT"]
  }
}

Similarly, an example response can be seen below:

{
    "id": "<ID>",
    "location": "https://api.autoscriber.com/v1/embed/<ID>",
    "embedLocation": "https://embed.autoscriber.com/?token=eyJhbGc..."
}

For the response, the following can be noted:

The embedLocation is the full iframe src URL, including the token.
The token is your JWT and is embedded as a query parameter in embedLocation .
You can use embedLocation directly as the value for the src attribute in your iframe.