Index

 

Speaking of REST services...

REST services allow you to safely access features and services outside the platform, using the authentication protocols OAuth 1, OAuth 2, and Basic authentication. This feature allows you to register, configure and test these services. For more technical and detailed information, see  REST services client authorization.

 

Basic path

 

01. From the main menu, click on Control panel

02. Click on the WCM tab.

03. Click on REST Services.

04. View the existing REST services.

 

Alternative paths

 

Add REST service

 

01. In the REST Services window, click on Add.

02. Enter the required information.

The fields highlighted with an asterisk (*) are mandatory.

Code
Service identification code. 

Domain
 Address corresponding to the service domain. Example: http://127.0.0.1:8080. 

Authentication type
Authentication protocol that will be used by the service. The available options are:
- OAuth 1;
- OAuth 2;
- Basic.

Consumer key
 Key to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Consumer secret
 Secrete key to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Access token
 Token to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1" or "Rest OAuth 2".

Secret token
 Secrete token to access the service. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Access token URL
URL for the token used to access the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Token request URL
URL for the token used to request the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

User authorization URL
URL for the user's access authorization to the provider. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 1".

Client Id.
Unique client key. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2". 

Client secret
Secret client key. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".  

Refresh token
Key to refresh token. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".  

Refresh token URL
URL to refresh token. This field is only displayed when the selected option in the Authentication type field is "Rest OAuth 2".

User
User sent in the request header.

Password
Password sent in the request header. 

Password confirmation
Confirmation of password sent in the request header.

URL for service test
Endpoint GET to test authentication of access to the provider.

03. Click on Save.


Edit REST service 

 

01. On the REST services window, select the service to be edited.

02. Click on Edit.

03. Change the information of your choice.

For more details about the fields displayed, see Add REST service.

04 . Click on Save.


Remove REST service 


01. On the REST services window, select the service to be removed.

02. Click Delete.

03. In the message that opens, click on Confirm to remove the service.

 

Test REST service 

 

01. On the REST services window, select the service that you wish to test.

02. Click on Test service

03. In the window displayed, click on Test service again.

04. View the result in the Test return table, which is displayed after the service test has finished.


This documentation is valid as of the 1.5.10 update. If you use a previous update, it may contain information different from what you see on your platform.