• Home
• Documentation
• Testing via Postman

Testing via Postman

A great way to get started with Zuva API is to use our Postman collection to explore the API and get familiar with the workflows you plan to use.

Tutorial

Use the following steps to get started with Postman.

Step 1: Install Postman

Download and install the Postman app.

Step 2: Get the Zuva Postman collection

Import our Postman collection from the Zuva API Postman workspace or GitHub.

Step 3: Set up your Postman environment

Create (or update) an environment under the Environments tab, by adding these variables:

• zdai-base-url: add the URL of the region you want to use Zuva (available on the Zuva API dashboard, e.g. https://<url_to_instance>/api/v2)

• token: add your token (Create a token on the Zuva API dashboard, if you haven’t yet)

Ensure that zdai-base-url points to the same region where your token was created.

Step 4: Try out some API calls

A good first request is “Get All fields”, found in the “Fields” folder. If you get a 200 response back, you’ll know that your token and base URL are correct and you can proceed to explore the rest of the API.

Step 5: Upload a file

On the ‘Submit a PDF File’ request (under the Files folder), you can upload a new file and submit it to Zuva. The file ID will automatically be saved in the environment for use in other requests.

Step 6: Try out other requests

Once your file is uploaded, you can try the other services. The general pattern is to first use a POST endpoint (such as “Create an OCR request), and then use a GET endpoint (such as “Get OCR request status”) to check if it has completed. Once the status is complete, some services have additional GET endpoints you can use to obtain results (such as “Get OCR request text”).

Step 7: Customize the field list for extraction

On the ‘Create a Field Extraction Request’ request (under the Field Extraction folder), you can change the fields to be extracted.

By exact string name

In the Pre-request Script tab, you can view the list of ‘field_names’ in the code snippet. You can add or remove fields from the list, but be aware that these must be an exact (case-sensitive) match for an existing field.

Changing the fields in this way will not have an effect unless the field_ids variable in your environment is empty.

By field ID

If you have the IDs of the fields you’d like to use, you can directly put them in the field_ids variable in the environment. Each ID should be surrounded by double-quotes, and IDs should be separated by commas. For example:

"292b0a57-596b-4904-acfa-c3f845eb2879","4d34c0ac-a3d4-4172-92d0-5fad8b3860a7","5c971bd8-fc3b-4a26-8a95-674202871dfd"