Step 3: Call an API proxy

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

In this step, you will test the API proxy you just created and deployed.

Apigee in Cloud console

  1. Open the Apigee UI in Cloud console in a browser.
  2. Make sure the same Google Cloud project where you created the API proxy is selected from the dropdown at the top of the page.
  3. In the Cloud console UI, select Management > Environments.
  4. Select the Environment Groups tab.
  5. In the table, find the row for the environment group that contains the environment where myproxy is deployed. The hostname appears in the Host Names column of this row. For example: mydomain.com.
  6. Call the API proxy. The way you call the proxy depends on whether your Apigee instance is configured for external or internal network access. If you aren't sure how your Apigee instance is configured, contact your Apigee administrator.
    • External access: If your Apigee instance is configured for external access, call the proxy as follows: 
      curl https://YOUR_ENV_GROUP_HOSTNAME/myproxy

      Where YOUR_ENV_GROUP_HOSTNAME is the hostname you obtained in the previous step.

      For example:

      curl https://mydomain.com/myproxy

      Here's another example, where the wildcard DNS service nip.io is used for the host:

      curl https://198.51.100.251.nip.io/myproxy
    • Internal access: If your Apigee instance is configured for internal network access, some extra steps are needed to obtain access to the internal load balancer and its IP address. For details, see Calling a proxy with internal-only access.
  7. A successful call to the proxy returns the following output:

    Hello, Guest!

Classic Apigee UI

  1. Open the Apigee UI in a browser.
  2. Make sure the same Google Cloud project where you created the API proxy is selected from the dropdown at the top of the page.
  3. In the Cloud console UI, select Admin > Environments > Groups.
  4. Click View in Google Cloud Console.
  5. Select the Environment Groups tab.
  6. In the table, find the row for the environment group that contains the environment where myproxy is deployed. The hostname appears in the Host Names column of this row. For example: mydomain.com.
  7. Call the API proxy. The way you call the proxy depends on whether your Apigee instance is configured for external or internal network access. If you aren't sure how your Apigee instance is configured, contact your Apigee administrator.
    • External access: If your Apigee instance is configured for external access, call the proxy as follows: 
      curl https://YOUR_ENV_GROUP_HOSTNAME/myproxy

      Where YOUR_ENV_GROUP_HOSTNAME is the hostname you obtained in the previous step.

      For example:

      curl https://mydomain.com/myproxy

      Here's another example, where the wildcard DNS service nip.io is used for the host:

      curl https://198.51.100.251.nip.io/myproxy
    • Internal access: If your Apigee instance is configured for internal network access, some extra steps are needed to obtain access to the internal load balancer and its IP address. For details, see Calling a proxy with internal-only access.
  8. A successful call to the proxy returns the following output:

    Hello, Guest!

If you get an error, check the following:

  • If you see a timeout error (unusual), try undeploying and redeploying the new API proxy.
  • If the host cannot be resolved, for example you receive a 404 error, double check that you are using the correct hostname and proxy name.
  • Make sure the environment group hostname is configured with the Cloud Load Balancer. See Determining whether the Cloud Load Balancer is configured for a hostname.
  • If you see a TLS/SSL error, such as an SSL handshake error, contact your DNS provider to make sure the DNS A record for the hostname is configured properly. Make sure the record has the IP of the load balancer that was created during Apigee provisioning. If you're not sure what the IP should be, see Determining whether the Cloud Load Balancer is configured for a hostname.
  • If you see a TLS/SSL certificate error, the SSL certificate associated with the load balancer might not have the correct hostname, and therefore is being rejected. The certificate was created during the provisioning process. The troubleshooting steps in Determining whether the Cloud Load Balancer is configured for a hostname show you how to locate and inspect the certificate.
  • If you're unable to resolve the problem, contact the person who provisioned Apigee for further assistance.

In the next step, you will change the target endpoint of the API proxy.

1 2 3 (NEXT) Step 4: Change the target endpoint 5