Interacting with your API

Once your API back end is deployed, it can be accessed in a variety of ways:

  • Browser address bar
  • Google API Explorer
  • Pylomer API front end
  • Javascript
  • Client libraries

Access as web page using browser address bar

Any unsecured or publicly-accessible parts of your API may be accessed in the same way as any web page, by entering its URL in the browser address bar. For example, product details might be displayed as such:<product_id>

Access with API Explorer

Once your API is deployed, it can always be accessed at its URL using the Google API Explorer. The URL for the deployed API yourapi will be a combination of its name and some other “boilerplate” elements:

Visiting this URL is a great way to interact with your API and explore its features without the need for any special client software. It displays a rich assortment of information. It’s rather cumbersome to use for creating entities, however, and the results it displays are useful mainly in verifying your API’s functionality. A particularly useful feature is that it handles authentication.

It might also be noted that all of Google’s public APIs such as Google+, YouTube, etc are designed to be interacted with using its API Explorer. It continues to receive enhancements as Google grows. So you can be sure that it will continue to be well supported.

Access with Pylomer API Admin Console

This is intended to be the primary means of accessing your API, at least until a website or mobile app is in use. Since there is no requirement that any such website or app accesss the totality of the API’s functionality, it might continue to be a primary means of interacting with your API indefinitely.

CORS Access with Javascript

Your API can be accessed in the same manner as all public Google APIs by using the standard Javascript HttpRequest library. CORS and authentication are supported. More information is available on Google’s website.

Client libraries

This is the preferred method of the accessing all Google APIs. Google API client libraries are published for Javascript and all other commonly used programming languages.

Google Cloud Datastore Console

The contents of your datastore can also be accessed using the Cloud Datastore. While this is not a means of interacting with your API, it is included here for reference as it provides a very convenient means of managing your data.