README

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

Run the following command to install the package and automatically add the dependency to your composer.json file:

composer require "chainlink/chainlink-apimatic-sdk:0.0.2"

Or add it to the composer.json file manually as given below:

"require": {
    "chainlink/chainlink-apimatic-sdk": "0.0.2"
}

You can also view the package at: https://packagist.org/packages/chainlink/chainlink-apimatic-sdk#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:

use CcipDirectoryAndConfigurationRestApiV1Lib\Logging\LoggingConfigurationBuilder;
use CcipDirectoryAndConfigurationRestApiV1Lib\Logging\RequestLoggingConfigurationBuilder;
use CcipDirectoryAndConfigurationRestApiV1Lib\Logging\ResponseLoggingConfigurationBuilder;
use Psr\Log\LogLevel;
use CcipDirectoryAndConfigurationRestApiV1Lib\Environment;
use CcipDirectoryAndConfigurationRestApiV1Lib\CcipDirectoryAndConfigurationRestApiV1ClientBuilder;

$client = CcipDirectoryAndConfigurationRestApiV1ClientBuilder::init()
    ->environment(Environment::PRODUCTION)
    ->loggingConfiguration(
        LoggingConfigurationBuilder::init()
            ->level(LogLevel::INFO)
            ->requestConfiguration(RequestLoggingConfigurationBuilder::init()->body(true))
            ->responseConfiguration(ResponseLoggingConfigurationBuilder::init()->headers(true))
    )
    ->build();

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

• ProxyConfigurationBuilder
• LoggingConfigurationBuilder
• RequestLoggingConfigurationBuilder
• ResponseLoggingConfigurationBuilder

HTTP

• HttpRequest

Utilities

• ApiResponse