...
This User Creation (REST) API is called with a payload (transmitted data) of the user information from the a third party provider's contact screen. The web application will run validations and create the user after the validations are passed. An option in the payload is to specify whether a welcome email is to be sent to the user.
NOTE - This API creates a user against an existing customer Customer so the customer code must already exist.
...
This is the primary data sent in the payload:
- First Name
- Surname
- Email Address
- Customer Code
- Account Administrator (for notification of newly-created user)
...
This guide covers what you have to do in the process to set up the User Creation API. To create code to retrieve the authorisation token and code to the API call endpoint, you will need the following:
...
...
Prerequisites
- URL (will be provided to you)
- Username
- Password
- API testing app / browser add-on:
- Postman (Chrome) - https://www.postman.com/downloads/
- Poster (Firefox) - https://addons.mozilla.org/en-US/firefox/addon/poster/
...
Before any API call is made, an authorisation token must be created. To retrieve the authorisation token and code to the API call endpoint, you will need the following:
- The ClientID and ClientSecret: Commerce Vision will provide these to you)
1. Open your Postman app.
...
- Token Type: this is the authorisation type that is needed for the api calls (should be 'bearer' usually)
- Access Token: this is the actual token
2. Make the API call
You will need:
- The Token API endpoint: /api/token
- The API endpoint: /api/user
The Token Type and Access Token are needed to make the API call. The API endpoint requires use of the token type and token in the authorisation header.
...