Api infrastructure, About the api infrastructure, Api license key – Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual
Page 22: Api license key exceptions, Chapter 3: api infrastructure
Chapter 3
API Infrastructure
19
API Infrastructure
Chapter 3
About the API Infrastructure
This chapter presents the common web service infrastructure features used by
the web services.
API License Key
The API license key is a unique identifier used during authentication. The key is a
string composed of 48 alpha numeric characters. This key is required for each of
your applications using the Service Management and Endpoint Resolver web
services, except for the test utility which does not use an API license key.
The Google Web Services API is deployed for smooth traffic flow to your web
service application. But in extreme situations where an application is straining the
system and threatening smooth traffic availability to other customers, Google
services will invalidate the errant application’s license key and stop access to the
web service. If your license key is revoked, a representative from the Early
Access Program will contact you. With these types of web service situations and
the described consequences, Google recommends rigorous testing of your
application’s performance before full deployment.
To get your API license key send mail to the Early Access Program’s support,
[email protected] to open a case via email. For code examples,
see “Endpoint Resolver Reference” on page 27, and
Management API Reference Guide
, “Service Management API” chapter.
Note:
An API license key is confidential and is equivalent to your personal login
and password. You are solely responsible for keeping it secure. It should not be
shared or distributed without Google written permission.
API License Key Exceptions
The API license key is a transport-layer attribute. And since an exception can be
thrown at any time and at any point thereby halting your application, it is important
that your application handles the API license key exceptions.