Skip to main content

Adding an API User

How to create and configure an API User on your service

Updated over a week ago

To add the Voice Agent into your call flow, you will first need to make sure you have an API User added to your service 

Step 1

To begin, create a new User in your instance of EMIS Web

Set the Username to SCCC

Do NOT tick "user must change password on next sign in" when the API User is created - please leave this blank

Use this Username and Password throughout the setup process

Role

Ensure the following settings are against the new API User:

  • Job Category to General Medical Practitioner

  • Appointment Session Holder to Yes

  • Patient Facing Services Booking to All Appointments

  • Consulter to Yes

  • User mnemonic to SC API

  • Relationship to Employed by Practice

  • Contract Start Date to current date

Under User Role Profiles please ensure that RBAC Role is set to Clinical Practitioner Access Role

Click OK

Then, in EMAS Manager, System Tools under Partner API, scroll down to Surgery Connect and select it

At the top, click Edit Users and in the window that opens sort by User Login and find SCCC. Click the checkbox and enter the same password as you used to create the user

Click Login Access and in the window that opens sort by User Login and click the checkboxes for Auto Login and Allow Login

NOTE: Some surgeries will already have an Integration API user for other third-party applications, please do not try to use these for Surgery Connect features as well, create a new API user

Once these fields are complete, click OK and complete the set up of your User

Step 2

Access the Service Delivery Console

The Integration API User then needs to be added to the Service Delivery Console, via the Advanced Tab

Select the Advanced tab

Click Manage Integration API users

Click the + Add New Integration API User button to add the details of the new API user you created


​Complete the required fields


The Label can be named by you and is a means to identify the API User easily

The Clinical System Reference will auto-fill if you have only one CDB, if you have more than one, please use the drop-down box to select the correct reference

Select your Region

The API User Login and API User password are those of the new API User created in EMIS Web


Save the Integration API User

A Success notification will show in the top right-hand corner of your screen

Your new API User will now show in your API User list


When you are ready to use the API User you will need to Validate it by clicking on the validate button

Start Block - Add your Integration API User

Double-click on the Start block to open the properties

Click on the Integrations tab

Select the EMIS Web API User from the dropdown

Click Save

Any changes you have made to your Start Block will be saved


Did this answer your question?