1.0 Introduction

1.7 User-Agent Header Requirements

Back to Index

All API-connecting software must include the HTTP User-Agent header to identify itself in the requests that it sends. To be more specific, interface.php will block requests with blank User-Agent headers. When such a request is received, the client software will be sent error code 113.

The User-Agent header is an RFC2616 Section 14 standard for HTTP requests. Information on the User-Agent header is available in section 14.43 “User-Agent” at http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html.

The HTTP User-Agent string included in each API request must contain, at a minimum, the vendor name, full identifying name of the application, and application version string. Additional information, such as included libraries and library version is also helpful, and may be included. The format should resemble the example below:

<VendorName (NOT initials)> <AppName> <AppVersion {x.x.x[.x]}>