Method: getEidparams

Gets the Proximity Beacon API's current public key and associated parameters used to initiate the Diffie-Hellman key exchange required to register a beacon that broadcasts the Eddystone-EID format. This key changes periodically; clients may cache it and re-use the same public key to provision and register multiple beacons. However, clients should be prepared to refresh this key when they encounter an error registering an Eddystone-EID beacon.

HTTP request

GET https://proximitybeacon.googleapis.com/v1beta1/eidparams

The URL uses Google API HTTP annotation syntax.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Information a client needs to provision and register beacons that broadcast Eddystone-EID format beacon IDs, using Elliptic curve Diffie-Hellman key exchange. See the Eddystone specification at GitHub.

JSON representation
{
  "serviceEcdhPublicKey": string,
  "minRotationPeriodExponent": number,
  "maxRotationPeriodExponent": number,
}
Fields
serviceEcdhPublicKey

string (bytes format)

The beacon service's public key for use by a beacon to derive its Identity Key using Elliptic Curve Diffie-Hellman key exchange.

A base64-encoded string.

minRotationPeriodExponent

number (uint32 format)

Indicates the minimum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent

maxRotationPeriodExponent

number (uint32 format)

Indicates the maximum rotation period supported by the service. See EddystoneEidRegistration.rotation_period_exponent

Authorization

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/userlocation.beacon.registry

For more information, see the Auth Guide.