WebApi Core Documentation

Navigation: Home > API Reference > WebApi Core

Overview

This directory contains the comprehensive documentation for the WebApi Core component of the Azure DevOps Node API. The WebApi Core is the foundational layer that handles authentication, connections, and provides access to all other API clients.

What's Included

This documentation covers:

• WebApi Core - Main documentation for the WebApi class and core functionality
• Authentication Handlers - Documentation for all authentication methods
• Connection Options - Documentation for connection configuration options

Related Resources

Learn more about using WebApi Core with these resources:

• Connect to Azure DevOps Tutorial - Step-by-step guide for connecting to Azure DevOps
• Troubleshooting Connection Issues - Solutions for common connection problems

Key Concepts

The WebApi Core documentation covers these essential concepts:

1. Connection Establishment

   • How to create and configure connections to Azure DevOps
   • Setting up authentication handlers
   • Testing connection status

2. Authentication Methods

   • Personal Access Token (PAT) authentication
   • Basic authentication
   • OAuth/Bearer token authentication
   • NTLM authentication for on-premises deployments

3. API Client Access

   • How to access specific API clients from the WebApi instance
   • Available API clients and their purposes
   • Best practices for API client usage

4. Connection Configuration

   • How to customize connection behavior with options
   • Proxy configuration
   • SSL settings
   • Timeout and retry settings

Target Audience

This documentation is designed for:

• Application developers integrating with Azure DevOps
• DevOps automation engineers
• CI/CD pipeline developers
• Azure DevOps extension developers

Usage Examples

Quick reference for common WebApi Core tasks:

// Basic connection with Personal Access Token (PAT)
import * as azdev from "azure-devops-node-api";

const orgUrl = "https://dev.azure.com/your-organization";
const token = "your-personal-access-token";
const authHandler = azdev.getPersonalAccessTokenHandler(token);
const connection = new azdev.WebApi(orgUrl, authHandler);

// Connect and get an API client
const workItemTrackingApi = await connection.getWorkItemTrackingApi();
const workItem = await workItemTrackingApi.getWorkItem(42);
Copy

See Also

• Git API Documentation - Documentation for Git API methods
• Work Item Tracking API Documentation - Documentation for Work Item Tracking API methods
• Build API Documentation - Documentation for Build API methods
• Integration Patterns - Documentation for integration patterns
• Glossary - Standardized terminology for the Azure DevOps Node API

Feedback

For issues, questions, or feedback regarding this documentation, please file an issue in the GitHub repository.