Summary
Postman is an API platform for building and using APIs. Postman simplifies each step of the API lifecycle and streamlines collaboration so you can create better APIs—faster. Postman allows you to easily edit API requests, view header information, and much more. Postman has the ability for you to save Collections or libraries of sample pre-made API requests.
Postman is free-to-use and is available to sign up and download here.
The Pigment collection import link is available here.
Importing The Collection
Within Postman, hit the import button and select link, paste this URL into the box and press continue. You’ll be taken to a tab outlining what will be imported. Once you have reviewed the content and are happy, press import. A new collection named Pigment API will be created for you.
Inside of it you’ll find the API calls currently supported by the service in a ready-to-go format, simply add your own details such as API key and block details.
Use the guide on Environment variables below for further information on what variables are available and where their values are found.
Using Environment Variables
This collection has been built to utilise Postman’s environment variables feature. You are free to continue using it, or hard-code your own values by replacing all of the placeholders denoted with a {{ and }} e.g. {{API_KEY}}.
To get started, read Postman’s documentation here and setup an existing or new Environment to configure the variables.
Below is a list of variables in the collection and their purpose:
CONFIGURATION_ID - Used in import data call. This value is set up within the Pigment UI as part of the import configuration process.
IMPORT_API_KEY - An API key with the import permission.
EXPORT_API_KEY - AN API key with the export permission.
VIEW_ID - Used in exporting table and metric data. A value in the page URL when viewing the block you want to export.
LIST_VIEW_ID - Used in exporting list data. A value in the page URL when viewing the block you want to export.
APPLICATION_ID - Used in all export API calls. A value in the page URL denoting the application ID that contains the block you wish to export.
ℹ️ Not sure where to find these values? There’s a detailed guide available here for exports and here for imports