heartgasil.blogg.se - Postman documentation

POSTMAN DOCUMENTATION HOW TO
POSTMAN DOCUMENTATION PRO
POSTMAN DOCUMENTATION PLUS
POSTMAN DOCUMENTATION DOWNLOAD

For readability, select the raw radio button to format the JSON request body. When editing a POST request, open the request and navigate to the Body section in the request editor. Depending on which HTTP method the endpoint uses, you’ll need to edit the pre-built request differently. In general, there are two types of requests that Braze’s API endpoints accept - GET and POST. This will open the request as a new tab in the main window of the Postman app. To start using one of the pre-built requests, click on it within the Collections menu of Postman. You can use any of the pre-built requests in the collection as a template for building new API requests. Once you have configured your environment. Using the pre-built requests from the collection We have already provided this formatting for you in this documentation’s POST request bodies, GET URLs, and environment template for YOUR-API-KEY-HERE. In POST request bodies, the api_key should be encapsulated in quotes: "MY-API-KEY-EXAMPLE".

Give this environment a name (e.g., “Braze API Requests”) and add keys for instance_url and api_key with values corresponding to your Braze instance and Braze REST API Key.

POSTMAN DOCUMENTATION PLUS

Click the + plus button to create a new environment.

From the Workspaces tab, select Environments.

To set up your own environment, perform the following steps: You can either select our templated environment (Braze REST API Environment Template) from the dropdown and replace the variable values with your own, or you can set up your own environment. Rather than having to manually edit all requests in the Collection, you can set up this variable in your Postman environment.

The Braze Postman Collection uses a templating variable, variable for your API Key. You can then create an environment, or use our Braze REST API environment as a template, and edit the available POST and GET requests to suit your own needs.

POSTMAN DOCUMENTATION DOWNLOAD

If you have a Postman account (you can download macOS, Windows, and Linux versions from the Postman website), you can open our Postman documentation in your own Postman app by clicking the orange Run in Postman button. View or download our Postman Collection by clicking Run in Postman in our Postman docs to get started. To make it easy for our customers to get up and running with our REST API, we created a Collection with pre-made examples for all of our API endpoints. Postman has the ability for you to save Collections or libraries of sample pre-made API requests. As opposed to other methods for interacting with APIs (e.g., using cURL), Postman allows you to easily edit API requests, view header information, and much more. Postman is a free-to-use visual editing tool for building and testing API requests.

POSTMAN DOCUMENTATION HOW TO

This reference article covers the Braze Postman Collection, what it is, how to set up and use the collection, as well as how to edit and send requests. This reminder is displayed when you mouse over the title of the description column.Braze allows you to generate sample API requests for all of our endpoints via our Postman Collection. Note: Descriptions are metadata for a request and are NOT sent with your HTTP request. You can hide and show the value and description column in the data editor by clicking on the ellipsis (…) in the top right corner of the editor, and unchecking the columns that you want to hide. Note: Descriptions for path variables and URL params are currently NOT shown in the documentation.

POSTMAN DOCUMENTATION PRO

One step closer to comprehensive API documentationįor Postman Pro users publishing internal or public API documentation, these descriptions are displayed in the automatically generated documentation for that collection. Y ou can now add comments and details for each of your query parameters, path variables, headers, and body ( form-data and urlencoded) – all from right within the Postman app.įor example, specify if an element is required or optional, indicate the accepted data type, or use alternative terminology to provide additional clarification for developers who are working with your requests. Postman is introducing a new description column in the data editor making your requests easier to understand.