How to enable, access and use the Platform API Tester, including changes in 8.5.

Answer

IMPORTANT: The API Tester is provided for development purposes only. You should NEVER include the API Tester in a production environment. Doing so can compromise your system security. If you insist on including it in your production environment (at your own risk), be sure to take standard measures, such as modifying the web.xml in your EAR to restrict access.

BEFORE MCF 8.5

Accessing the API Tester

Prior to MCF 8.5, the URL used to access the API Tester (if included in the build) was:

http://<hostname or address>:<port>/yantra/yfshttpapi/yantrahttpapitester.jsp

AFTER MCF 8.5

Including the API Tester in the build

To include the API Tester in the build, specify the following parameter when calling buildear.sh (as described in the Installation Guide)

-Ddevmode=true

Accessing the API Tester

Beginning with MCF 8.5, since the WAR file is now smcfs.war, use the following URL:
http://<hostname or address>:<port>/smcfs/yfshttpapi/yantrahttpapitester.jsp

API Tester Security

Additionally, beginning with MCF 8.5, the servlet requires authentication from a valid user. To use the API Tester, one must now specify a userid and password in the startup screen as shown below:


Specify your userid/password in the above fields. If any user other than the Administrator needs to access the API Tester, then give that user permission to access this resource (the API Tester) by adding it to the Resource group through the Configurator. For further details on security in the API Tester, refer to the Installation Guide of 8.5.

Disabling API Tester Security

In the development environment one can disable the security. To do so, specify the following properties in customer_overrides.properties

• yfs.interopservlet.auth.token.enabled=false
• yfs.interopservlet.auth.userPassword.enabled=false