ChainlinkApimaticSDK 0.0.2

Getting Started with CCIP directory and configuration REST API (v1)

Introduction

Deprecation: This CCIP Directory and configuration REST API (v1), including /api/ccip/v1/* on docs.chain.link, is planned for deprecation soon. Timelines and migration guidance will be published in the CCIP Tools documentation. For new integrations, prefer the CCIP Tools REST API (v2) where it meets your needs.

REST API for CCIP supported chains, tokens, lanes, and related configuration on docs.chain.link. This is distinct from the CCIP Tools REST API (v2), which covers messages, lane latency, intents, and related tooling (https://docs.chain.link/ccip/tools/api/). For on-chain Solidity, Move, SVM, and TON interfaces, see https://docs.chain.link/ccip/api-reference.

To get started quickly, you can download our Postman Collection which includes all endpoints and example requests.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ChainlinkApimaticSDK --version 0.0.2

You can also view the package at: https://www.nuget.org/packages/ChainlinkApimaticSDK/0.0.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using CcipDirectoryAndConfigurationRestApiV1.Standard;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

CcipDirectoryAndConfigurationRestApiV1Client client = new CcipDirectoryAndConfigurationRestApiV1Client.Builder()
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(CcipDirectoryAndConfigurationRestApiV1.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using CcipDirectoryAndConfigurationRestApiV1.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = CcipDirectoryAndConfigurationRestApiV1Client
    .FromConfiguration(configuration.GetSection("CcipDirectoryAndConfigurationRestApiV1"));

See the Configuration-Based Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

List of APIs

• Chains
• Tokens
• Lanes

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter