Skip to main content

Relay

Delegate user sessions across partner apps using Relay. Learn how to use it from setup to user transitions.
info

Please provide this guide to your

The fallback content to display on prerendering
that will get the
The fallback content to display on prerendering
. You also can read it, to understand what happened next after your
The fallback content to display on prerendering
leaves your own
The fallback content to display on prerendering
.

What's a Relay ?

The Cryptr

The fallback content to display on prerendering
determines the configuration that will allow you to exchange authenticated
The fallback content to display on prerendering
from a direct
The fallback content to display on prerendering
you manage to another
The fallback content to display on prerendering
The fallback content to display on prerendering
.

We design this operation to be carried out with as little action as possible.

So we're going to proceed in 2 steps.

  1. Create the

    The fallback content to display on prerendering
    configuration that specifies the
    The fallback content to display on prerendering
    and where to redirect the
    The fallback content to display on prerendering
    on its
    The fallback content to display on prerendering
    .

  2. Create the

    The fallback content to display on prerendering
    request, that manages the
    The fallback content to display on prerendering
    redirection from a current Access Token to the final
    The fallback content to display on prerendering
    of the
    The fallback content to display on prerendering
    .

Introducing the Relay flow.​

Cryptr Relay Flow

  1. I get the relay_uri via an HTTP POST request, which is a tokenized URI to which the user is redirected from their access_token.

  2. The

    The fallback content to display on prerendering
    validates this tokenized URI, then redirects the user to the
    The fallback content to display on prerendering
    service (via the partner_redirect_uri).

  3. The

    The fallback content to display on prerendering
    arrives on the
    The fallback content to display on prerendering
    service with an authorization_code, which allows the
    The fallback content to display on prerendering
    The fallback content to display on prerendering
    to obtain a new dedicated access_token via HTTP POST request.

1. Relay Configuration​

First we need to create a

The fallback content to display on prerendering
. A

The fallback content to display on prerendering
for Cryptr is the configuration of a "bridge" between your app and your
The fallback content to display on prerendering
app. To create a
The fallback content to display on prerendering
, we pass a new
The fallback content to display on prerendering
that represents your
The fallback content to display on prerendering
.

To do this, you need to know the URL your

The fallback content to display on prerendering
should be redirected when they move from your service to your
The fallback content to display on prerendering
app.

Relay creation​

curl -X POST ${cryptr_service_url}/api/v2/relays \
    -d partner_domain='communitiz-app' \
    -d partner_redirect_uri='https://communitiz-app.com/welcome'
info

The

The fallback content to display on prerendering
you want as your
The fallback content to display on prerendering
must have its field allowed_email_domains empty. In fact, your partner must allow
The fallback content to display on prerendering
with different email addresses to log in.

Manage the Relay

Here are the other possible actions for managing

The fallback content to display on prerendering
:

Update the Relay​

This request will help you to update the

The fallback content to display on prerendering
parameters.

curl -X PUT ${cryptr_service_url}/api/v2/relays/:relay_id \
  -d partner_redirect_uri='https://new-app.communitiz-app.com/welcome'

Delete the Relay​

curl -X DELETE ${cryptr_service_url}/api/v2/relays/:relay_id

Retrieve the Relay​

curl "${cryptr_service_url}/api/v2/relays/:relay_id"

You are now able to view the params of your

The fallback content to display on prerendering
.

List the Relays​

curl "${cryptr_service_url}/api/v2/relays"

Now that our

The fallback content to display on prerendering
is configured, we can create
The fallback content to display on prerendering
requests.

2. Relay Requests​

In this section we'll look at how you can create a

The fallback content to display on prerendering
request to send your
The fallback content to display on prerendering
to your
The fallback content to display on prerendering
service.

To do this, you need to have a

The fallback content to display on prerendering
configured and know its ID, as well as the

The fallback content to display on prerendering
of the
The fallback content to display on prerendering
currently logged on to your service.

Relay Request creation​

curl -X POST ${cryptr_service_url}/api/v2/relays/:relay_id/request \
    -d access_token='eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3Mi...'

Once this request has been used, you should obtain a relay_uri.

note

Your

The fallback content to display on prerendering
should be redirected to this URL. This URL contains the information your
The fallback content to display on prerendering
service needs to identify and authenticate the
The fallback content to display on prerendering
.

What happens after the redirection​

The next step will have to be carried out by your

The fallback content to display on prerendering
.

Once your

The fallback content to display on prerendering
is redirected to the relay_uri, they will enter the
The fallback content to display on prerendering
process. The
The fallback content to display on prerendering
will then be redirected to your
The fallback content to display on prerendering
The fallback content to display on prerendering
. Your
The fallback content to display on prerendering
, in turn, will receive an authorization code. This code will be used to authenticate the user.

Once your partner has performed the necessary actions and if everything is in order, the user authenticated on your side should now also be authenticated on your

The fallback content to display on prerendering
side.

To support your

The fallback content to display on prerendering
actions as effectively as possible, you can send them the Partner Relay Guide.

Conclusion​

I hope this guide has given you a better understanding of the steps involved in

The fallback content to display on prerendering
between your
The fallback content to display on prerendering
and the
The fallback content to display on prerendering
of your
The fallback content to display on prerendering
. Here is a summary of the topics covered:

  • The creation of a
    The fallback content to display on prerendering
     with all the configuration params needed.
  • The Relay Request, to request the redirection of your
    The fallback content to display on prerendering
    to your
    The fallback content to display on prerendering
    service.
  • What your partner will have to do on their side

To test and ensure the operation of your Relay system, here is a practical tip:

  • You can try to perform a Relay request with Users from the Cryptr sandbox.

API endpoint used in this guide​

You can read more about

The fallback content to display on prerendering
used,during this guide to our API Reference.

Endpoints
POST /api/v2/relays

Create a new Relay
POST /api/v2/relays/:relay_id/request

Create a new Relay Request for a user and get a relay_uri
Logo de Cryptr
Consult our Changelog