Red Shell

REST API Quick Start

Is your game written in a language that isn't supported by one of our SDKs? Do you need to send your postbacks from a server rather than the game client? Don't worry! Using our REST API you can still get up and running with Red Shell quickly and easily.

1. Collect Identifiers

Before you will be able to send an event to the Red Shell API you will need to collect some identifiers from the user's computer. This information is used as part of the Red Shell fingerprinting process. You can see the details on the available identifiers and expected formats here.

Server to Server Integration

Most of our customers choose to call our API directly from the game client, but if for some reason it is easier to implement the call from one of your servers please note the changes in "Appendix: Sending Events from a Server" or else your integration will not function properly.

2. Setup Conversion Call

Now that you've collected the identifiers you're ready to setup a conversion call. The final step is to set up a postback to Red Shell upon game launch so we can track conversions. This should happen as soon after your game has launched as possible.

curl https://api.redshell.io/events \
	-X POST \
	-H 'Authorization: SOMEAPIKEYHERE' \
	-H 'X-Api-Version: 1.1.0' \
	-H 'Content-Type: application/json' \
	-d "$(cat <<-EOF
  {
    "user_id": "b91f8k5r",
    "type": "game_launch",
    "identifiers": {
      "resolution": "1920x1080",
      "os": "Windows 10",
      "language": "en",
      "timezone": 420
    }
  }
EOF)"

NOTE: This example call does not include all possible identifiers.
** Note: The event of type "game_launch" must be sent when the game starts for conversion tracking and retention reporting to work. If this is not possible please contact us and we can help with your integration

3. All Done!

That's it! You have now integrated the Red Shell REST API into your game. For details on more advanced integrations check out our complete reference.

You can also checkout our Testing Your Game Integration guide for details on how you can ensure your integration was successful.

Appendix: User Notice

While the information provided to Red Shell may not be considered personally identifiable, we recommend that you provide your users with either notice of the integration, opt in, or op out of our services in your game. While not legally not required given the nature of the data, in our experience many gamers are more comfortable with control over what information their game sends. Red Shell also provides platform level opt-outs for users who chose where possible. The "Do Not Track" list feature in the Red Shell dashboard can be used to process right to forget requests. Any right to access requests can be handled by contacting our privacy team directly at privacy@redshell.io.

Please note that this is not legal advice, please consult with the legal department of your company to determine what the best approach is for your company and users.

Appendix: Sending Events from a Server

The IP address of the player's computer is used as part of our attribution process. When events are logged to our API from a server instead of directly from the game client we require that the player's IP is manually passed to our API. like so:

Note the added "ip" parameter in the body of the event payload.

curl https://api.redshell.io/events \
	-X POST \
	-H 'Authorization: SOMEAPIKEYHERE' \
	-H 'X-Api-Version: 1.1.0' \
	-H 'Content-Type: application/json' \
	-d "$(cat <<-EOF
  {
    "user_id": "b91f8k5r",
    "type": "game_launch",
    "ip": "172.123.345.14",
    "identifiers": {
      "resolution": "1920x1080",
      "os": "Windows 10",
      "language": "en",
      "timezone": 420
    }
  }
EOF)"

REST API Quick Start