(New!) Create a service account and its API key

Modified on Thu, 22 Aug at 11:39 AM

In this article, you will learn how to create a service account and how it works.

SUMMARY


What is a service account ?


A service account is an account with limited access.

Unlike a classic account, a service account will not have access to XMCO applications, but will still be able to use the API and receive e-mail notifications. 


This is particularly interesting if you have third-party task automation accounts, or global mailing lists.


How to create a service account ?


Pre-requisite : you need an account with the Manager profile


Step 1 : go to the user list


1. Go to Users list from the configuration wheel next to your user initials.



2. Click on the “+” symbol in the top right-hand corner. A pop-up window opens.



Step 2 : Fill in the details of the user


In the pop-up window, enter the following information:

  • First name
  • Last name
  • Cell phone number
  • User language
  • Email address



Step 3 : Activate the Service account option


Tick the following checkbox: This is a service or limited user account



Step 4 : Assign perimeters to the account


  1. Enter the profile(s) assigned to the user (ex: regular user, manager)
  2. Enter the subscription(s) assigned to the user (ex: Serenety, Yuno)
  3. Enter the perimeter(s) assigned to the user for each subscription selected




Step 5 : Confirm the creation of the account


Click on Add to confirm account creation.


Warning !
For security reasons, the “Service account” option is only available when the account is created and cannot be changed later on by the user.

If you need to convert a classic user account into a service account, please contact support (support@xmco.fr) or open a ticket directly on Freshdesk.


How to generate an API key for a service account ?


Pre-requisites :

  • An account with the Manager profile
  • A service account set up


Step 1 : go the User list with the Manager profile


1. Go to the Users list from the configuration wheel next to your user initials.


2. Search for the name of the previously created service account in the list. You can also use the search bar, or search only for service accounts in the field provided.


Step 2 : Access service account details


Click on the name of the service account to access its parameters.



Step 3 : Access the Service Account Security menu

Click on the Security menu (left menu).



Step 4 : Generate an API key


Click on the Generate API key or Reset this token button.


Your API key is now generated and available in the text field. An “API key successfully created” message should appear in the top right-hand corner.



The button next to the generated key () will let you easily copy it.




Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article