Yordex

Authentication

This tutorial has the following sections:

Buyers and sellers

Buyers and sellers authenticate using our API keys. Please contact us to get your API key.

The example below shows what that looks like when creating an order:

curl https://api.yordex.com/v1/orders  
-H "Authorization:your-api-key"  
-H "Content-type: application/json"  
-X POST  
-d '{ 
  "buyerId" : "other-trader-id",
  "sellerId" : "your-trader-id"
}'

The API key is sent in the "Authorization" field of the HTTP header.

In the this documentation we always use "your-api-key" in the Authorization headers. To get your API key, direct customers of Yordex can sign up to our test environment and contact us to get their API key.

If you wish to offer Yordex to your own customers, "your-api-key" is the connectionApiKey that is returned when creating a trader. This means you will have a different key for all the traders they manage. You will then also get access to our partner portal.

Third Parties

Parties that aren't either buyer or seller can also access Smart Orders. We distinguish between two types of third parties:

  • Connectors act on behalf of a buyer or seller and can do exactly what that buyer or seller can do. Every connector has its own API key that is separate from the buyer or seller's API key but that provides the same access rights.
  • Service providers are companies providing logistics, financial or other services to buyers and sellers. They can read orders but their ability to update orders is limited to what is required for them to provide the service

Both connectors and service providers are given API keys and API authorisation works exactly as for buyers and sellers.

Updated 2 years ago


What's Next

Test environment

Authentication


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.