Developer Guide

A developer's guide into technical side of Gateway Relay. Lays out the optimal paths for understanding the architecture of Gateway Relay, as well as for interacting with the API.

Prerequisites

  1. Ensure that you have the Universal Profile extension installed. UP Extension Download Link

  2. Using the UP Extension, make a Universal profile by clicking your UP Extension, and then clicking the "Create Profile" button that appears. Follow the instructions and personalize the profile to your liking.

Diving into the Technical side

  1. Learn about the functionalities that Gateway Relay provides. Learning the high level of everything that is offered by the Gateway Relay platform, and how it fits together will greatly enhance your ability to interact with the API.

  2. OPTIONAL: Watch the Gateway Relay demo. To pull all of these concepts together, it might be a good idea to give the Gateway Relay demo a watch.

  3. Learn about Gateway Relay's architecture. By learning about the components that go into making Gateway Relay what it is, you will have a better understanding of what goes on under the hood, and how to interact with the API.

  4. Learn about the Authentication Flow. An understanding of the authentication flow is pivotal to interacting with the Gateway Relay API, as it is necessary to call it's core endpoints.

  5. Learn about the API. With steps 1-3 done, you can dive into the API feeling confident that you can utilize it to it's full capacity.

  6. OPTIONAL: Read up on the roadmap. Get prepared for what's on the way by looking into the roadmap.

Last updated