Skip to main content

Partner Relay

Learn how to use a Relay from the Partner point of view.
info

If you are the

The fallback content to display on prerendering
of an
The fallback content to display on prerendering
, you are in the good place. If this is not the case, please consult this guide instead.

What's a Relay ?

A

The fallback content to display on prerendering
is a Cryptr resource that determines the configuration that will allow to exchange authenticated
The fallback content to display on prerendering
with another
The fallback content to display on prerendering
.

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

So there's only one thing to do on your side.

  1. Authenticate the
    The fallback content to display on prerendering
    .

Relay Configuration

First, the application for which you will be a

The fallback content to display on prerendering
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 the
The fallback content to display on prerendering
for which you are a
The fallback content to display on prerendering
.

To do this, the source app needs to know the URL to which

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

Relay Requests

In this section we'll look at how the source application can create a

The fallback content to display on prerendering
request to send their
The fallback content to display on prerendering
to you service.

To do this, the application must 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 connected to their service.

Once the request has been performed, the source application should obtain a relay_uri.

note

The

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

1. Authenticate the user

The next step will have to be carried out by you.

Once the

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
. You, in turn, will receive an authorization code. This code will be used to authenticate the user.

This code, also called authorization_code have to be used with the endpoint below:

Get an access_token

curl -X POST '${cryptr_service_url}/api/v2/oauth/token' \
-d grant_type="relay" \
-d code={code}

If everything is in order, the user authenticated on the source app should now also be authenticated on your side.

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 source
The fallback content to display on prerendering
for which you are a partner. 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 an
    The fallback content to display on prerendering
    to your service.
  • Getting the access_token, for the
    The fallback content to display on prerendering
    on your 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.