Skip to content
Postman API Testing Tips

How To Use Postman With Leankit

API Testing Blog

Integrating LeanKit with Postman for Efficient API Testing

LeanKit, a popular project management tool, empowers teams to visualize their workflows and track progress. While LeanKit offers excellent project management capabilities, it’s crucial to ensure that the APIs powering the platform are robust and reliable. This is where Postman, a powerful API testing tool, comes in.

Why Integrate LeanKit with Postman?

Integrating LeanKit with Postman offers a seamless way to streamline your API testing process, resulting in faster development cycles, improved quality, and increased confidence in your application. Here’s how this integration benefits you:

  • Efficient API Testing: Postman’s intuitive interface streamlines API testing by providing a structured environment for defining, executing, and managing tests.
  • Automated Tests: Automate your API tests to catch errors early, reducing the risk of bugs reaching production.
  • Collaboration: Share tests and results easily within your team, promoting transparency and seamless collaboration.
  • Data-driven Insights: Analyze test data to monitor API performance, identify bottlenecks, and make informed decisions about your application.

Step-by-Step Guide to Integrating LeanKit with Postman

1. Obtain LeanKit API Credentials

  • Create a LeanKit Account: If you haven’t already, create a LeanKit account.
  • Generate API Keys: Login to your LeanKit account and navigate to the “Settings” section.
  • API Access: Locate the “API Access” tab and click on “Generate API Keys.”
  • Create New Key: Create a new API key and store the “Key” and “Secret” securely.

2. Install Postman

  • Download and Install: Download the latest version of Postman from the official website (https://www.postman.com/).
  • Create a New Workspace: Create a new workspace in Postman to organize your tests related to the LeanKit API.

3. Create a Postman Collection

  • Create Collection: Create a new collection in Postman to group all your LeanKit API tests.
  • Add Requests: Add individual requests to the collection for each API endpoint you want to test. For example, you might create requests for:
    • Retrieving a list of boards
    • Creating a new card
    • Updating a card’s status

4. Define Request Parameters

  • Request Method: Select the appropriate HTTP request method (GET, POST, PUT, DELETE) for each API call.
  • URL: Enter the LeanKit API endpoint you want to test. Example: https://api.leanKit.com/1.0/boards/.
  • Headers: Add the necessary headers, including Authorization with your generated API key and “Content-Type” for JSON requests.
  • Body: Add request payloads in JSON format, if required.

5. Sample API Calls with Code Examples

  • Get a List of Boards:
// Request
GET https://api.leanKit.com/1.0/boards/


// Headers
Authorization: Basic YOUR_API_KEY:YOUR_API_SECRET
Content-Type: application/json


// Expected Response
[
  {
    "id": 1234,
    "name": "My Board",
    ...
  }
]
  • Create a New Card:
// Request
POST https://api.leanKit.com/1.0/boards/1234/cards


// Headers
Authorization: Basic YOUR_API_KEY:YOUR_API_SECRET
Content-Type: application/json


// Request Body
{
  "title": "New Card",
  "laneId": 5678,
  ...
}


// Expected Response
{
  "id": 9101,
  "title": "New Card",
  ...
}
  • Update a Card’s Status:
// Request
PUT https://api.leanKit.com/1.0/cards/9101


// Headers
Authorization: Basic YOUR_API_KEY:YOUR_API_SECRET
Content-Type: application/json


// Request Body
{
  "laneId": 9876,
  ...
}


// Expected Response
{
  "id": 9101,
  "title": "New Card",
  "laneId": 9876,
  ...
}

6. Writing Assertions and Tests

  • Add Assertions: Use Postman’s assertion feature to verify that your API responses meet your expectations. For example, you can assert that:
    • The response status code is 200 (OK)
    • The response body contains the expected data
    • The response time is within acceptable limits
  • Create Tests: Combine multiple assertions into tests to automate the validation process.

7. Running and Analyzing Tests

  • Run Tests: Run your tests to check API functionality.
  • Generate Reports: Analyze the test results to identify failing requests, performance issues, or areas for improvement.

8. Utilizing Postman for Continuous Integration/Continuous Development (CI/CD)

  • Integrate with CI/CD: Use Postman’s integration capabilities to run API tests as part of your CI/CD pipeline, ensuring that every code change is tested before deployment.

Conclusion

Integrating LeanKit with Postman empowers you to streamline your API testing process, ensuring that your LeanKit implementation is robust and reliable. By leveraging Postman’s features for automation, collaboration, and detailed testing, you can achieve faster development cycles, improved application quality, and greater confidence in your LeanKit-powered applications.

API Testing Blog