General overview

The big picture. Environments, guides, data-flows.

Environments

Youstice maintains two completely separate environments for integration purposes. Their pros/contras and characteristics are explained below:

Sandbox

  • Running an identical version of the software in the production environment.
  • Includes the Youstice ODR application running under https://app-sand.youstice.com and the
  • API gateway, reachable on https://api-sand.youstice.com.
  • This environment is an ideal playground and the perfect place to collect first-hand information and experience.
  • This environment should in general be preferred for integration tests, before switching to production. Access to this environment is free of charge. Everybody is welcome to register and look around.

Register into Sandbox here.

Warning: Data (including your account and claims) may be refreshed/wiped from time to time. Also, this environment may be subject to occasional downtimes without prior notice. Furthermore, certain features may not be enabled (e.g. escalation).

qr code, production registration

Production

  • The right place to do real dispute resolution and negotiate with your clients.
  • Includes the Youstice ODR application running under https://app.youstice.com and the
  • API gateway, reachable on https://api.youstice.com.
  • All features are enabled and accessible
  • High-available, 24x7 operation
  • Certain actions may be subject payment. Claims are monitored for fraud.
  • You're welcome to register into the production environment any time. However, it is assumed that you've already spent some time in the Sandbox.

Register into Production here.

Warning: This environment is not suitable as a playground.

qr code, production registration

Registration

Registration is the very first activity you need to carry out when you want to use services provided by Youstice. If this is your first time here, we recommend to first register into the Sandbox here. After you're registered, you'll have to create at least 1 shop. Once a shop is set up, look for the "Integration information" in the shop's properties, and note the "API key". You're now ready to set up integration in your eShop Software.

Depending on the brand of the SW you're using, you may be able to find a ready-made plugins for the e-Shop platform, or you'll have to write the integration code yourself. In both cases You'll have to provide the plugin/library the API key exactly as it appears on your screen. Once that's done, you're ready to test the communication between your SW and Youstice.

Note: Treat the shop's API key as secret, and do not share or publish it. Best to keep it on the server-side, protected from prying eyes. While the API key will be part of every single information exchange between your server and Youstice, it will always be transmitted over an encrypted channel.

See the picture below outlining the necessary steps:

registration

Important! Once you're happy with the integration, you're encouraged to sign-up and register yourself into the production environment. At the same time, you'll have to replace the API keys in your e-Shop plugins/custom integration code with the new API keys that you get in the Production environment for every one of your registered shop.


The process

See the diagram below for a simple outline for the claim submission, negotiation and escalation process

process

API key and Shop/Site ID


The API key / Site ID is a unique and secret identification of a shop which you registered with Youstice under your profile. Every single API call is using this key to identify itself, and to identify the shop which is the subject of the claim. You can find the API key / Site ID (formerly ShopID) after logging in, clicking on "Integration and customization" in the top navigation menu and clicking on a specific site to show it's profile. On the "General Settings / Basic info" tab you'll see the the API key and the Site ID. See the screen shots below:

Site ID and ApiKey