Authorization

In order to use the service, you have to attach your personal api key to each request you make. You can find, create and regenerate your personal api key in your dashboard at https://dashboard.vatzen.com.

VatZen API Authorization is based on your personal api key, which you can obtain from the dashboard. You're required to pass this api key along with every request you make to the API. You can pass it in 2 ways: via x-api-key header in HTTP headers, or in the request query as an api_key parameter.

Below, 2 examples of how you can provide your api key.

1) Provide a token in the request's query

Simple example of how to use your token inside the request's query to fetch all the actual API rates:

https://api.vatzen.com/v1/rates?api_key=aea3661794add2e8e799ab005c2bd607

2) Provide a token in the request's header

You can also provide a token in your request's header. For example, if you are writing JavaScript code and using fetch to send requests:

fetch('https://api.vatzen.com/rates', {
mathod: 'GET',
headers: {
'x-api-key': 'aea3661794add2e8e799ab005c2bd607',
},
});

Sometimes it can be useful and can help you define the general authorization strategy for all the calls you make to VatZen API.

Public Key

For some use cases, you'd want to fetch certain information from public spaces, like your frontend application and it's a bad practice to expose your api key that way.

To solve this problem, VatZen provides you with a public key, which you can find in the dashboard and which can be used to access selected endpoints (see documentation).

Public key can only be provided via query param as public_key, for example, if you want to get previously saved price object, you can make the following request:

https://api.vatzen.com/v1/prices/123?public_key=pk_aea36sddd2e8e799ab005c2bd607

Reseting API key

You can reset your api key anytime from your dashboard if you think that your token has been compromised. In order to to that, you can navigate to the "API Key" section of the dashboard and click regenerate button.