Postman Quickstart

What is Postman?

Postman is an API platform for building and using APIs. In this quickstart, we'll use Postman as a convenient API client to visually interact with the Invoicetronic API without needing to write any code.

Before continuing, make sure all the prerequisites below are met.

Prerequisites

Postman is downloaded and installed on your system.
You obtained an active API Key.
You registered with the Italian Revenue Service (needed for the live environment)

Import the OpenAPI specification

Open Postman and log in with your user account if needed. With recent versions of Postman, creating a free user account is required to use the Import feature.

Open the File menu and click on Import... to open the import window.

You can copy and paste the Invoicetronic API OpenAPI specification URL or drag and drop it if you already downloaded it to your system (alternatively, browse it).

Once that's done, Postman will ask you how to import the specification file:

Confirm the default option by pressing the Import button. With that done, you should now see the Invoicetronic API Collection in your Postman workspace. Expand the collection to see all the available endpoints.

Postman workspace — Invoicetronic API as a Postman Collection.

Set your API Key

Click on the Authorization tab. You will find that the Basic Auth scheme is pre-selected, but we want to set our test API Key so we don't have to re-enter it at every request.

Postman authorization tab — Replace `ik_test_MY_API_KEY` with your **test** API Key.

Hover over the Username text box. A dialogue with several options will pop up. Fill the "enter value" box with your test API Key and click on Collection to set the Username to the whole Collection scope (you can ignore the Password field). The variable {{basicAuthUsername}} will turn blue, confirming it has been set.

Postman: the test API Key has been set — The **test** API Key has been set for the Collection scope.

Now click on the Variables tab to confirm find that basicAuthUsername is set to your test API Key, and baseUrl is set to the API entry point.

Postman variables tab — All variables are set and ready to go.

We are now ready to make a request.

Make a request

Expand the receive branch in the Invoicetronic API Collection and select the "List of incoming invoices" endpoint. In the right pane, you have the request URL prefilled and a list of all query parameters (make sure you deselect them if they are selected).

Click the Send button to receive a list of inbound invoices.

Postman request — Our first successful request.

Congratulations, you just performed a successful GET request.

Not receiving invoices in the live environment?

Ensure your correspondents use 7HD37X0 as the value of their invoices' Codice Destinatario field. That is how SDI knows they should be forwarded to the Invoicetronic API.