gep13/appveyor-postman

A set of re-usable postman scripts for working with the AppVeyor API

appveyor-postman

This repository contains a Postman collection and environment file that can be used to exercise the AppVeyor API.

Video

A short video explaining what this is, and how to use it can be found here:

Getting Started by importing from Link

1. Open Postman

2. Click Import

3. Click Import From Link

4. Paste the following Link https://raw.githubusercontent.com/gep13/appveyor-postman/master/AppVeyor.postman_collection.json

5. Click Import

6. Click the Environment Options gear at the top right hand corner of Postman

7. Click Manage Environments

8. Click Add

9. Add a key for each of the following:

   • accountName
     • The name of the account that hosts the AppVeyor project you want to work with
   • projectSlug
     • The identifier for the AppVeyor project you want to work with
   • authenticationToken
     • The API Token of the user that you want to use to access the API. Log into ci.appveyor.com and then select the drop down list at the top right hand corner and click API Token.
   • recordsPerPage
     • The number of records to return in historical queries

10. Click Add

11. Close the Manage Environments window

12. In the collections list on the left hand side, expand AppVeyor then Projects and Builds

13. Double click on Get Projects request

14. In the Environments drop down list at the top right hand corner of Postman, select the Environment that you named earlier

15. Click send

16. If everything has worked, you should get a list of projects for the account associated with the API Token that you used

Getting Started by cloning Repository

To get started with this collection and test that everything is working, after cloning this repository, follow these steps:

1. Open Postman

2. Click Import

3. Click Choose Files

4. Browse to the location where you cloned the repository to

5. Select the AppVeyor.postman_collection.json file and click Open

6. Click the Environment Options gear at the top right hand corner of Postman

7. Click Manage Environments

8. Click Import

9. Click Choose Files

10. Browse to the location where you cloned the repository to

11. Select the AppVeyor Empty.postman_environment.json file and click Open

12. Click the newly imported Environment

13. Edit the name of the Environment as required (for example, to the name of the AppVeyor project you want to work on)

14. Fill in the required information:

    • accountName
      • The name of the account that hosts the AppVeyor project you want to work with
    • projectSlug
      • The identifier for the AppVeyor project you want to work with
    • authenticationToken
      • The API Token of the user that you want to use to access the API. Log into ci.appveyor.com and then select the drop down list at the top right hand corner and click API Token.
    • recordsPerPage
      • The number of records to return in historical queries

15. Click Update

16. Close the Manage Environments window

17. In the collections list on the left hand side, expand AppVeyor then Projects and Builds

18. Double click on Get Projects request

19. In the Environments drop down list at the top right hand corner of Postman, select the Environment that you named earlier

20. Click send

21. If everything has worked, you should get a list of projects for the account associated with the API Token that you used

Feel free to try out the other requests that are included within this collection.