⏱️Setup

About project

The platform offers real API functionality that can be used for API integration practice or testing.

The project consists of several functional modules. To access any endpoint, you must pass an access token in the request header so that the API user can be identified.

In this article, we'll cover the basic setup. It's very simple!

1. Create an account

Pass the registration stage through one of the systems

2. Create an access token

To access project endpoints, you need to create an access token.

  1. Click "Create Token

  2. Set the necessary settings for each of the modules.

  3. Click “Create”

What are additional module features?

You can customize the logic of each module to change the flow. For example, if you set "email confirmation" for the authentication module, then you will have an intermediate step that will request a confirmation code from the mail. You can create multiple access tokens and configure each one differently.

3. Working with a Postman collection

To simplify working with modules, I created a Postman collection that describes all requests.

To get started, open it by following the link below

Postman collection setup

  1. Follow the link above

  2. Log in to your Postman account

  3. Return to this collection

  4. Go to the environments section

  5. Enter your access key in the API_KEY field, which you created above

Conclusion

Now you can work with the simulator endpoints.

If you go to the headers section, in any of the requests, you will see that your access token is passed in the x-api-key header.

When you work with APIs outside of Postman, you must also pass this header.


🎉 In the following articles we will look at the logic and configuration of each of the simulator modules.

Last updated

#20:

Change request updated