Skip to main content

Authentication

The ZBD API uses API Keys to authenticate requests. Each one of your Games in the ZEBEDEE Developer Dashboard will have an unique associated API Key that allows for the management and control over that Game's Bitcoin Lightning Wallet. To find your unique GAME_API_KEY, or to regenerate the API Key for a specific Game, head over to Developer Dashboard >> Game >> API Access.

Authenticating Requests

Authentication to the API is required for all endpoints provided, and is performed by passing the Game's API Key as the apikey HTTP request header property.

Request HeaderValue
apikeyGAME_API_KEY

Any and all requests that do not feature a valid apikey header property in the request will be rejected.

SSL / HTTPS Access

The ZBD API only provides a secure interface over HTTPS with SSL certificate support. Any and all requests that attempt to reach the ZEBEDEE API in an insecure fashion (plain-text over HTTP requests) will be rejected.

tip

Secure Sockets Layer (SSL) is the standard security technology for establishing an encrypted link between a server and a client. SSL allows sensitive information such as credit card numbers, social security numbers, and login credentials to be transmitted securely.