Google Search Appliance Administrative API Developers Guide: Protocol - Manual (Page 6)

Google Search Appliance: Administrative API Developer’s Guide: Protocol 6
• Create—Operations to add a new object, such as a collection or front end. To perform any of these
operations, issue an HTTP POST request with the appropriate URL. The body of the POST request is
an XML document that contains information about a resource to create.
• Retrieve—Operations to request and obtain information about search appliance features. For
information on the Google Data API retrieval operations, see the Google Search Appliance
Administrative API Developer’s Guide: Java and Google Search Appliance Administrative API Developer’s
Guide: .NET. To retrieve information about a resource, issue an HTTP GET request to the appropriate
URL that identifies a resource to retrieve.
• Update—Operations to modify information about search appliance. To update the information,
issue an HTTP PUT request to the appropriate URL. The body of the PUT request is an XML
document that contains information about a resource to update.
• Delete—Operations to delete objects such as a collection or a front end. To perform any of these
operations, issue an HTTP DELETE request to the appropriate URL. The URL contains information
that identifies a resource to delete.
The search appliance verifies that all create and update requests contain valid XML, include all required
data fields, and meet authentication requirements.
Authenticating Your Google Search Appliance Account
You can send API requests over HTTPS or HTTP.
Specify an authentication token with each API request. The search appliance uses the token to authorize
access to the operation that you request. Authentication tokens are available only to users who have
administrative rights to the search appliance, and the tokens authorize operations only within a search
appliance.
To obtain an authentication token, submit an HTTP POST request to port 8443 on a search appliance as
shown in the following URL:
https://Search_Appliance:8443/accounts/ClientLogin
The following guidelines apply to the request:
• Include in the POST body a string in the following format:
&Email=username&Passwd=password
Make the following changes to this string:
a. Replace username with a user name that has an Admin Console administrator account.
b. Replace password with the password for the Admin Console account.
• The user name and password values must be URL-encoded. For example, the URL-encoded form of
the AcQ.87@ password is the AcQ%2E87%40 value.
• The POST request must specify the value application/x-www-form-urlencodedfor the Content-
Type header.