...
| Excerpt | ||
|---|---|---|
| ||
Set up User Creation API to allow a user to be created from the a third party contact screen. |
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 so the customer code must already exist.
This is the primary data sent:
...
If the user already exists, you will be alerted with a message.
Guide
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:
- The ClientID and ClientSecret (will be provided : Commerce Vision will provide these to you)
- The Token api API endpoint: /api/token
- The api API endpoint: /api/user
Prerequisites
- URL (will be provided to you)
- Username
- Password Sample Setup Request file (see example at the end of this page)
- API testing app / browser add-on:
- Postman (Chrome) - https://chromewww.googlepostman.com/webstore/detail/postman/fhbjgbiflinjbdggehcddcbncdddomop?hl=endownloads/
- Poster (Firefox) - https://addons.mozilla.org/en-US/firefox/addon/poster/
...
Before any API call is made, an authorisation token must be created.
1. Open Open your Postman app.
2. Set the request type to 'POST'.
3. Enter the URL in the Access Token URL fieldIn Access Token URL, enter the URL (given to you).
4. Add the client ID and Client Secret provided to you.
6. Click Get New Access Token to get the token. The 'Authorization' uses the above auth value to generate the token:
7. The response is an object with two fields:
- 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
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.
...