API introduction

You use the zeuz API to access zeuz functionality via game clients, external services (for example, to manage your payloads), and the zeuz tool CLI. You can use either the zeuz API or the zeuz control panel (ZCP) to manage zeuz orchestration, or a combination of both.

You can use the zeuz API to automate certain tasks, for example:

API functionality

The API is based around three core sets of functionality; allocations, payloads, and game image management.

The core methods are listed below in simplified pseudo code:

API options and API authentication

Depending on how you use the API, you might have to set up API request authentication.

API options

You can use the zeuz API in a number of ways, depending on the coding language you use to develop your game:

  • Wrappers in the zeuz SDK download for the following coding languages:

    • Unity (C#)
    • Unreal Engine (C++ and Blueprint)
  • SDK in Go.

  • The zeuz base API, which uses JSON-over-HTTP.

    See API authentication overview for details.

API authentication

The wrappers and SDK in Go handle request authentication, and serialize the data in your API requests. You can integrate the wrappers directly into your Unity, Unreal or Go code. To use the wrappers, get the latest zeuz SDK download and refer to the readme.txt file in the unzipped package for details.

If you don’t develop your game in Unity, Unreal, or Go, you can use the zeuz base API directly. You might also use the zeuz base API to build tools around your game, for example to integrate your game into your CI/CD pipeline.

To do this, you need to incorporate the supported authentication method for the zeuz base API into the scripts you use to make API requests. See API authentication overview for more information.

More information

See the following pages for more information about specific zeuz API functionality:

2021-may-12 Page added with editorial review.

Last edited on: October 13, 2021 (149a70bd)