All docs This doc

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: DOCUMENTATION-4182

...

The URL appears next to “Mgt Console URL” in the start script log that is displayed in the command window. For example:

Image RemovedImage Added

The URL should be in the following format: https://<Server Host>:9443/carbon

...

Info

Any configurations (including valves defined in the <PRODUCT_HOME>/repository/conf/tomcat/catalina-server.xml file) apply to all Web applications and are globally available across the server, regardless of the host or cluster. For more information about using remote host filters, see the Apache Tomcat documentation.

Accessing the API Publisher

Once the server has started, you can run the API Publisher by typing its URL in a Web browser. The following sections provide more information about running the API Publisher:

Working with the URL

The URL appears next to “API Publisher Default Context” in the start script log that is displayed in the command window. For example:

Image Added

The URL should be in the following format: https://<Server Host>:9443/publisher

You can use this URL to access the API Publisher on this computer from any other computer connected to the Internet or LAN. When accessing the API Publisher from the same server where it is installed, you can type localhost instead of the IP address as follows: https://localhost:9443/publisher

Signing in

At the sign-in screen, you can sign in to the API Publisher using admin as both the username and password.

Info

When the API Publisher sign-in page appears, the Web browser typically displays an "insecure connection" message, which requires your confirmation before you can continue.

The API Publisher is based on the HTTPS protocol, which is a combination of HTTP and SSL protocols. This protocol is generally used to encrypt the traffic from the client to server for security reasons. The certificate it works with is used for encryption only, and does not prove the server identity. Therefore, when you try to access the API Publisher, a warning of untrusted connection is usually displayed. To continue working with this certificate, some steps should be taken to "accept" the certificate before access to the site is permitted. If you are using the Mozilla Firefox browser, this usually occurs only on the first access to the server, after which the certificate is stored in the browser database and marked as trusted. With other browsers, the insecure connection warning might be displayed every time you access the server.

This scenario is suitable for testing purposes, or for running the program on the company's internal networks. If you want to make the API Publisher available to external users, your organization should obtain a certificate signed by a well-known certificate authority, which verifies that the server actually has the name it is accessed by and that this server actually belongs to the given organization

Accessing the API Store

Once the server has started, you can run the API Store by typing its URL in a Web browser. The following sections provide more information about running the API Store:

Working with the URL

The URL appears next to “API Store Default Context” in the start script log that is displayed in the command window. For example:

Image Added

The URL should be in the following format: https://<Server Host>:9443/store

You can use this URL to access the API Store on this computer from any other computer connected to the Internet or LAN. When accessing the API Store from the same server where it is installed, you can type localhost instead of the IP address as follows: https://localhost:9443/store

Signing in

At the API Store home page, you can click sign in link at top right corner to sign-in to the API Publisher using admin as both the username and password.

Info

When the API Store home page appears, the Web browser typically displays an "insecure connection" message, which requires your confirmation before you can continue.

The API Store is based on the HTTPS protocol, which is a combination of HTTP and SSL protocols. This protocol is generally used to encrypt the traffic from the client to server for security reasons. The certificate it works with is used for encryption only, and does not prove the server identity. Therefore, when you try to access the API Store, a warning of untrusted connection is usually displayed. To continue working with this certificate, some steps should be taken to "accept" the certificate before access to the site is permitted. If you are using the Mozilla Firefox browser, this usually occurs only on the first access to the server, after which the certificate is stored in the browser database and marked as trusted. With other browsers, the insecure connection warning might be displayed every time you access the server.

This scenario is suitable for testing purposes, or for running the program on the company's internal networks. If you want to make the API Store available to external users, your organization should obtain a certificate signed by a well-known certificate authority, which verifies that the server actually has the name it is accessed by and that this server actually belongs to the given organization

Stopping the server

To stop the server, press Ctrl+C in the command window, or click the Shutdown/Restart link in the navigation pane in the Management Console. If you started the server in background mode in Linux, enter the following command instead:

...