Our team have created a public Postman workspace where we provide access to API collections from our modules. You can copy these API collections to test them in your own Magento installation together with our modules, and some collections can be tested directly in our workspace using demo API endpoints.

At the moment, the following extensions are added to the workspace:

To begin, log into Postman, or create an account there if you haven't got one yet, and open one of the module collections using the links above.

If you'd like to explore how API works in Amasty demo environment, choose the module you're interested in, and locate its collection. First, it is necessary to generate a temporary admin token, so that API queries can be sent in the backend. Open the very first query in the module collection called Get Admin Token:

In the Overview tab, all the necessary details for generating the token (admin area and password) are already filled in, so all that's left is to generate the token itself. Click on Send button to the right of the query:

In the Response section of the page, a generated token should appear. It will be automatically passed into other queries as a variable, so there's no need to enter it for authorization each time when you're trying out a new API query for the same module:

Now you can proceed with checking demo queries. Choose the API query you'd like to review:

Since we've just generated the authorization token, it has been automatically inserted in the Overview tab as a variable. Click on Next button:

On top of the page, you'll see the example of the API query that you're about to send:

Under the query, choose the data that you'd like to pass with it. All the queries have their unique sets of parameters based on what extension you're utilizing (for example, company, quote, label, form, etc.), the data found in the entity from the extension (company status, its store credit balance, contact address, and so on).

Another factor that influences the list of required parameters is method type: for GET and DELETE methods, queries usually require sending only one or several parameters, while POST and PUT methods also require including a JSON body with the information you'd like to send. Let's review both cases: 

To test such queries, it is sufficient to insert the parameter(s) that'll help locate the data. In our example, we want to obtain data about a certain company, so in the getCompanyById query you can specify the ID of the company you need the data from:

Insert the necessary data and click on Send button. As a result, if a company with such ID exists in Magento, Response section will return a JSON containing company data:

For those cases that require passing a JSON body in the query, first you might require to indicate the parameters as in the example above (for example, ID of a company that you'd like to edit), and proceed to the following step where you'll paste the data. Let's review the updateCompany query that edits information inside the company. Once you've filled in company ID, it is necessary to click on Next button, and then open JSON editor by clicking on Open Body to Edit:

 

Module collections already contain a sample JSON with all the necessary components for the query. You can use it as it is and send a query with our ready-to-go sample, or you can edit the values inside it according to your liking:

If you want to test API collections using the data from your own Magento environment where the module is already installed, you may either export module collection as a JSON file, or fork it to your Postman workspace. The former option is convenient if you want to run API tests in offline environments, or of you prefer to use some other tool rather than Postman; the latter, in its turn, is the best choice for quick online tests of a Magento installation with minimal changes involved.

Click on three dots to the right from the collection's name and choose Export option:

Confirm your choice in a popup, and a JSON file will be downloaded. We recommend choosing the latest format version available, as they're compatible with a greater number of various tools:

You will be redirected to your own workspace where you can customize the collection now:

Before running API queries, you will need to insert the data for your specific Magento instance into collection variables (its Rest API URL, admin username and password).