![]() Click on “ GET API Key Owner.” You should see a screen similar to the one below.Open the “ User” folder by clicking on it. You should now see the Postman API collection on the workspace you selected on the fork process above.You should see a form that lets you pick a label for your fork and select the workspace where your fork will be made. Among other things, you should see the documentation and the “ Fork” button on the header, as illustrated by the following image. Open the official Postman API documentation.To fork the Postman API collection, follow these steps: Forking creates a copy of the whole collection that you can use without remembering how the API works. Let’s get started by forking the Postman API collection. Reading the documentation shows that the endpoint “allows you to fetch relevant information about the API key being used.” In other words, this endpoint will return information about the user that owns the API key that is being used to authenticate the call. Let’s find an endpoint that doesn’t change anything and lets you understand how the Postman API works and how you can interpret its responses. The first thing to do is find a good candidate for a first call to the Postman API. ![]() To make calls to the Postman API, you’ll use Postman itself. Now that you have your API key safe and stored in an environment and access to the Postman API documentation, it’s time to start using it. Once you’re done, click “ Save,” and you’ll have your generated API key store on an environment. Copy the value of the generated API key into the “Initial value” cell. Give your new environment a meaningful name, e.g., “Postman Production,” and add a new variable called postman_api_key.Create a new environment by clicking on “ Create a new Environment” or, if you already have environments, by clicking on the plus sign above (“ +”).Click on “ Environments.” You should see a list of your existing environments, or if you don’t have any, a message inviting you to create one.Let’s first create an environment by following these steps: Environments are used to store values that you can later use when making requests. Postman has a great way of doing that, and it’s called an environment. Having generated an API key, it’s now time to store it in a place where you can easily use it whenever you need it. Your new API key is generated, and you’re asked to copy it to the clipboard otherwise, you’ll lose it forever.Give it a name, and then click on “ Generate API Key.” A form will open, asking you to name your new API key.You should now see a screen that lets you manage your API keys.On the same screen, you should see a left navigation menu. Your profile form appears, letting you edit it.Click on your avatar in the top right corner.So, how do you get an API key, and how do you use it? Follow these steps to generate an API key: If you share an API key with someone else, they will be able to interact with the Postman API on your behalf. An API key identifies who you are and lets the system know what you can do with the Postman API. You can think of an API key as a way to identify who you are whenever you make a request to any of the endpoints available on the Postman API. To start interacting with the Postman API, you first need to have an API key. There’s also available information about rate limits, the different HTTP status codes, and the required authentication that uses the API key scheme. You will find general information on getting started and specific documentation for each of the existing endpoints and operations. ![]() The easiest way to start learning is by consulting the official Postman API documentation. Finding information about the Postman API ![]() During this article, you’ll learn how to use the Postman API, and you’ll get hands-on building a project that lets you synchronize your local OpenAPI specification files with Postman. The Postman API is a great way to do just that. While most of the work can and should be done interactively using a GUI, you sometimes need to automate certain tasks and integrate Postman with other tools. Why would you use the Postman API, you may ask. Did you know that Postman has its own API? Yes, Postman, an API platform that helps you design, test, mock, and document APIs in a collaborative fashion, has its own API.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |