You can create an instance of HttpHelper using the ExternalApiAttributes class. This allows you to configure headers, retry logic, timeouts, and certificates.

This example demonstrates how to use HttpHelper to send a GET request to an external API and deserialize the response into a strongly typed object. It also shows how to configure headers, disable retry logic, and log the response output.

string baseAddress = "https://jsonplaceholder.typicode.com";
Dictionary<string, string> headers = new Dictionary<string, string>() { //define headers };
ExternalApiAttributes externalApiAttributes = new(baseAdderess, headers)
{
    Retry = new Retry()
    {
        IsEnabled = false
    },
    RequestTimeout = 10
};
var httpHelper = GetHttpHelper(externalApiAttributes);
var logHelper = GetLogHelper();

string url = "/todos/1";
var response = await httpHelper.GetAsync<SampleResponse>(url);
logHelper.LogDebug(response);

Console Output:

Complete-GetAsync(https://jsonplaceholder.typicode.com/todos/1), HttpStatus=OK, Time=285.534
{"userId":1,"id":1,"title":"delectus aut autem","completed":false}

This example demonstrates how to send data to an external API using a POST request. It shows how to retrieve data using a GET request, modify the response payload, serialize the request body, and submit it using HttpHelper.

string baseAddress = "https://jsonplaceholder.typicode.com";
Dictionary<string, string> headers = new Dictionary<string, string>() { //define headers };
ExternalApiAttributes externalApiAttributes = new(baseAdderess, headers)
{
    Retry = new Retry()
    {
        IsEnabled = true,
        Count = 2
    },
    RequestTimeout = 20
};
var httpHelper = GetHttpHelper(externalApiAttributes);
var logHelper = GetLogHelper();

string url = "/todos/1";
var response = await httpHelper.GetAsync<SampleResponse>(url);

url = "/todos";
response.id = 0;
response.title = "Callback";
var contentToPost = new StringContent(JsonConvert.SerializeObject(response),Encoding.UTF8,"application/json");
var postResult = await httpHelper.PostAsync<SampleResponse>(url,contentToPost);
logHelper.LogDebug(postResult);

Console Output:

Complete-GetAsync(https://jsonplaceholder.typicode.com/todos/1), HttpStatus=OK, Time=285.534
{"userId":1,"id":1,"title":"delectus aut autem","completed":false}
Complete-PostAsync(https://jsonplaceholder.typicode.com/todos), HttpStatus=Created, Time=400.073
{"userId":1,"id":201,"title":"Callback","completed":false}

This example demonstrates how to pass request-specific headers using HttpRequestOptions. Use this approach when headers vary between requests and should not be configured globally while creating the HttpHelper instance.

using Conga.Platform.Extensibility.CustomCode.Library;
using Conga.Platform.Extensibility.CustomCode.Library.Models;
using System.Collections.Generic;
using System.Net.Http;
using System.Text;
using System.Text.Json;
using System.Threading;
using System.Threading.Tasks;
using CustomHttpRequestOptions = Conga.Platform.Extensibility.CustomCode.Library.Models.HttpRequestOptions;

namespace CustomApi.Template
{
    public class SampleAccount : CodeExtensibility
    {
        public async Task<string> GetBadgeInfoAsync(CancellationToken cancellationToken)
        {
            ThrowIfCancellationRequested(cancellationToken);
            string requestUri = "/MyBadge";
            string baseRequestUri = "https://dummyjson.com";
            ExternalApiAttributes externalApiAttributes = new ExternalApiAttributes(baseRequestUri);
            Dictionary<string, string> additionalHeaders = new Dictionary<string, string>()
            {
                {"x-name", "Test" }
            };
            var httpHelper = base.GetHttpHelper(externalApiAttributes);

            var response = await httpHelper.GetAsync(requestUri,
                new CustomHttpRequestOptions()
                {
                    AdditionalHeaders = additionalHeaders
                });
            return await response.Content.ReadAsStringAsync();
        }

        

        public async Task<string> PostExternalAsync(CancellationToken cancellationToken)
        {
            ThrowIfCancellationRequested(cancellationToken);
            string requestUri = "https://dummyjson.com/products/add";
            ExternalApiAttributes externalApiAttributes = new ExternalApiAttributes(requestUri);
            var httpHelper = base.GetHttpHelper(externalApiAttributes);

            Dictionary<string, string> data = new()
            {
                {"title", "BMW Pencil" },
                {"description", "BMW Pencils" },
                {"brand", "BMW" }
            };
            Dictionary<string, string> additionalHeaders = new Dictionary<string, string>()
            {
                { "x-header", "sample-host" }
            };
            HttpContent httpContent = new StringContent(JsonSerializer.Serialize(data), Encoding.UTF8, "application/json");
            var response = await httpHelper.PostAsync(requestUri, httpContent, new CustomHttpRequestOptions()
            {
                AdditionalHeaders = additionalHeaders
            });
            return await response.Content?.ReadAsStringAsync();
        }
      


        public async Task<string> PutExternalAsync(CancellationToken cancellationToken)
        {
            ThrowIfCancellationRequested(cancellationToken);
            string requestUri = "https://dummyjson.com/products/1";
            ExternalApiAttributes externalApiAttributes = new ExternalApiAttributes(requestUri);
            var httpHelper = base.GetHttpHelper(externalApiAttributes);

            Dictionary<string, string> data = new()
            {
                {"title", "BMW Pencil" },
                {"description", "iPhone Galaxy +1" },
                {"brand", "iPhone" }
            };
            Dictionary<string, string> additionalHeaders = new Dictionary<string, string>()
            {
                { "x-host", "sample-host" }
            };
            HttpContent httpContent = new StringContent(JsonSerializer.Serialize(data), Encoding.UTF8, "application/json");
            var response = await httpHelper.PutAsync(requestUri, httpContent, new CustomHttpRequestOptions()
            {
                AdditionalHeaders = additionalHeaders
            });
            return await response.Content?.ReadAsStringAsync();
        }

        public async Task<string> PatchExternalHttpContentAsync(CancellationToken cancellationToken)
        {
            ThrowIfCancellationRequested(cancellationToken);
            string requestUri = "https://dummyjson.com/products/1";
            ExternalApiAttributes externalApiAttributes = new ExternalApiAttributes(requestUri);
            var httpHelper = base.GetHttpHelper(externalApiAttributes);

            Dictionary<string, string> data = new()
            {
                {"description", "iPhone Galaxy latest" },
                {"brand", "iPhone" }
            };
            Dictionary<string, string> additionalHeaders = new Dictionary<string, string>()
            {
                { "x-test", "sample-host" }
            };
            HttpContent httpContent = new StringContent(JsonSerializer.Serialize(data), Encoding.UTF8, "application/json");
            var response = await httpHelper.PatchAsync(requestUri, httpContent, new CustomHttpRequestOptions()
            {
                AdditionalHeaders = additionalHeaders
            });
            return await response.Content?.ReadAsStringAsync();
        }
      
        public async Task<string> DeleteExternalAsync(CancellationToken cancellationToken)
        {
            ThrowIfCancellationRequested(cancellationToken);
            string requestUri = "https://dummyjson.com/products/1";
            ExternalApiAttributes externalApiAttributes = new ExternalApiAttributes(requestUri);
            var httpHelper = base.GetHttpHelper(externalApiAttributes);

            Dictionary<string, string> additionalHeaders = new Dictionary<string, string>()
            {
                { "x-host", "sample-host" }
            };

            var response = await httpHelper.DeleteAsync(requestUri, new CustomHttpRequestOptions()
            {
                AdditionalHeaders = additionalHeaders
            });
            return await response.Content?.ReadAsStringAsync();
        }
      
    }
}