search
Page cover

binary-circle-checkData Formats

Within the Relevo platform, a variety of specialized data formats are used to enable secure and reliable communication between systems. Understanding these formats is essential when integrating Relevo into your business processes. Relevo representatives are always available to assist during the integration phase, ensuring a smooth setup and a waste-free experience for your guests.

If you wish to test your integrations or applications before deployment, Relevo provides a development environment that mirrors the real system. Contact your Relevo representative to request access.

You can find our full API overview here: Relevo Swagger OpenAPIarrow-up-right

chevron-rightRelevo User IDhashtag

A 6-character long alphanumerical lower case identifier for a Relevo User. In a QR code format, the Relevo User ID is prefixed with rlv:// to make it easy to identify. Our API endpoints accept just the Relevo User ID, as well as the full version with schema.

Example: rlv://3p1kfv

chevron-rightItem UIDshashtag

All Relevo items are trackable through a unique identifier. This identifier is alphanumerical with special symbols and case sensitive. It's between 22 and 25 characters long.

Example: _a-fmpS_qxETitrM9kFd4g

chevron-rightBlack and white item stickershashtag

Relevo's items have stickers on the side of the item. The QR code on them can have two different formats:

  1. White stickers with just the Item UID

  2. Black stickers with a fully qualified domain name and the Item UID

While Relevo switched to black QR codes a while ago and does not hand out any more white stickers, you might still encounter them and therefore should always check for both options. Note, that our API does that for you and you can simply forward your scanned codes to the API.

chevron-rightItem QR Code Parametershashtag

In our black item stickers, we have a fully qualified domain name in the QR code, as well as individual item characteristics that make the borrowing experience more enjoyable. These are:

  • uid: (string) the uId of the item the sticker is on

  • n: (string) the name of the item that is also printed on the sticker

  • mc: (number) the meta category id of the item the sticker is on

  • c: (string) CUPS or BOWLS as rough category of the item the sticker is on

Only uid and n are required in the QR codes. This is enough during an offline experience to at least show the name of the item that is also printed on the sticker. For further refinements, the meta category id or the category of the item can also be given to show even more detail without any network calls.

Example: https://app.relevo.de/borrow?uid=8o1T8EAJbaeDAP5kCCI9NnRnj&n=Mombert&mc=1&c=CUPS

chevron-rightReturn QR Code Parametershashtag

Our Return Code Posters have a large QR code printed on them that encodes information on the location. This also allows us to provide extra information during an offline return scenario on device. The used parameters are:

  • uid: (string) the uId of the return code

  • rid: (number) the location Id the return code belongs to

  • n: (string) name of the location the return code belongs to

Only the rid and uid parameters are required. Please note that the name of the location is URL encoded.

Example: https://app.relevo.de/return?uid=Xn6vkHRgrZXBLtuIDCIUo2vB5&rid=123&n=Coucou+Food+Market+-+Neuhausen

chevron-rightTrusted domainshashtag

To offer a nice experience to new users, our App Clip and Instant Apps require full URLs to work. Relevo might expand and change its URL portfolio in the future, but for now you should only accept QR codes coming from these domains:

  • relevo.de

  • *.relevo.de

Last updated

Was this helpful?