Platform

Manage the building blocks of Codat, including companies, connections, and more.

Summary

Platform API: Platform API

An API for the common components of all of Codat's products.

These end points cover creating and managing your companies, data connections, and integrations.

Read about the building blocks of Codat... | See our OpenAPI spec

Endpoints

| Endpoints | Description | | :- |:- | | Companies | Create and manage your SMB users' companies. | | Connections | Create new and manage existing data connections for a company. | | Connection management | Configure connection management UI and retrieve access tokens for authentication. | | Webhooks | Create and manage webhooks that listen to Codat's events. | | Integrations | Get a list of integrations supported by Codat and their logos. | | Refresh data | Initiate data refreshes, view pull status and history. | | Settings | Manage company profile configuration, sync settings, and API keys. | | Push data | Initiate and monitor Create, Update, and Delete operations. | | Supplemental data | Configure and pull additional data you can include in Codat's standard data types. | | Custom data type | Configure and pull additional data types that are not included in Codat's standardized data model. |

Table of Contents

• Platform
  • Endpoints
  • SDK Installation
  • Example Usage
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Authentication
  • Requirements
  • Debugging
  • Support

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @codat/platform

PNPM

pnpm add @codat/platform

Bun

bun add @codat/platform

Yarn

yarn add @codat/platform

Example Usage

SDK Example Usage

Example

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatPlatform.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Available Resources and Operations

Companies

• list - List companies
• create - Create company
• get - Get company
• delete - Delete a company
• replace - Replace company
• update - Update company
• addProduct - Add product
• removeProduct - Remove product
• refreshProductData - Refresh product data
• getAccessToken - Get company access token
• getCompanySyncSettings - Get company sync settings
• setCompanySyncSettings - Set company sync settings

~~ConnectionManagement~~

• ~~get~~ - Get access token (old) :warning: Deprecated Use getAccessToken instead.

Connections

• list - List connections
• create - Create connection
• get - Get connection
• delete - Delete connection
• unlink - Unlink connection
• updateAuthorization - Update authorization

~~Cors~~

• ~~get~~ - Get CORS settings (old) :warning: Deprecated Use get instead.
• ~~set~~ - Set CORS settings (old) :warning: Deprecated Use set instead.

CustomDataType

• configure - Configure custom data type
• getConfiguration - Get custom data configuration
• refresh - Refresh custom data type
• list - List custom data type records

Integrations

• list - List integrations
• get - Get integration
• getBranding - Get branding

PushData

• getModelOptions - Get push options
• listOperations - List push operations
• getOperation - Get push operation

ReadData

• getValidationResults - Get validation results

RefreshData

• all - Refresh all data
• byDataType - Refresh data type
• get - Get data status
• listPullOperations - List pull operations
• getPullOperation - Get pull operation

Settings

• get - Get CORS settings
• set - Set CORS settings
• getProfile - Get profile
• updateProfile - Update profile
• getSyncSettings - Get sync settings
• updateSyncSettings - Update all sync settings
• listApiKeys - List API keys
• createApiKey - Create API key
• deleteApiKey - Delete API key

SupplementalData

• configure - Configure
• getConfiguration - Get configuration

Webhooks

• listConsumers - List webhook consumers
• createConsumer - Create webhook consumer
• deleteConsumer - Delete webhook consumer

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

• companiesAddProduct - Add product
• companiesCreate - Create company
• companiesDelete - Delete a company
• companiesGet - Get company
• companiesGetAccessToken - Get company access token
• companiesGetCompanySyncSettings - Get company sync settings
• companiesList - List companies
• companiesRefreshProductData - Refresh product data
• companiesRemoveProduct - Remove product
• companiesReplace - Replace company
• companiesSetCompanySyncSettings - Set company sync settings
• companiesUpdate - Update company
• connectionsCreate - Create connection
• connectionsDelete - Delete connection
• connectionsGet - Get connection
• connectionsList - List connections
• connectionsUnlink - Unlink connection
• connectionsUpdateAuthorization - Update authorization
• customDataTypeConfigure - Configure custom data type
• customDataTypeGetConfiguration - Get custom data configuration
• customDataTypeList - List custom data type records
• customDataTypeRefresh - Refresh custom data type
• integrationsGet - Get integration
• integrationsGetBranding - Get branding
• integrationsList - List integrations
• pushDataGetModelOptions - Get push options
• pushDataGetOperation - Get push operation
• pushDataListOperations - List push operations
• readDataGetValidationResults - Get validation results
• refreshDataAll - Refresh all data
• refreshDataByDataType - Refresh data type
• refreshDataGet - Get data status
• refreshDataGetPullOperation - Get pull operation
• refreshDataListPullOperations - List pull operations
• settingsCreateApiKey - Create API key
• settingsDeleteApiKey - Delete API key
• settingsGet - Get CORS settings
• settingsGetProfile - Get profile
• settingsGetSyncSettings - Get sync settings
• settingsListApiKeys - List API keys
• settingsSet - Set CORS settings
• settingsUpdateProfile - Update profile
• settingsUpdateSyncSettings - Update all sync settings
• supplementalDataConfigure - Configure
• supplementalDataGetConfiguration - Get configuration
• webhooksCreateConsumer - Create webhook consumer
• webhooksDeleteConsumer - Delete webhook consumer
• webhooksListConsumers - List webhook consumers
• ~~connectionManagementGet~~ - Get access token (old) :warning: Deprecated Use companiesGetAccessToken instead.
• ~~corsGet~~ - Get CORS settings (old) :warning: Deprecated Use settingsGet instead.
• ~~corsSet~~ - Set CORS settings (old) :warning: Deprecated Use settingsSet instead.

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatPlatform.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatPlatform.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Error Handling

CodatPlatformError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { CodatPlatform } from "@codat/platform";
import * as errors from "@codat/platform/sdk/models/errors";

const codatPlatform = new CodatPlatform({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  try {
    const result = await codatPlatform.companies.list({
      query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
      orderBy: "-modifiedDate",
      tags: "region=uk && team=invoice-finance",
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.CodatPlatformError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorMessage) {
        console.log(error.data$.statusCode); // number
        console.log(error.data$.service); // string
        console.log(error.data$.error); // string
        console.log(error.data$.correlationId); // string
        console.log(error.data$.validation); // shared.ErrorValidation
      }
    }
  }
}

run();

Error Classes

Primary errors:

• CodatPlatformError: The base class for HTTP error responses.
  • ErrorMessage: Your query parameter was not correctly formed.

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from CodatPlatformError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  serverURL: "https://api.codat.io",
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatPlatform.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to:

• route requests through a proxy server using undici's ProxyAgent
• use the "beforeRequest" hook to add a custom header and a timeout to requests
• use the "requestError" hook to log errors

import { CodatPlatform } from "@codat/platform";
import { ProxyAgent } from "undici";
import { HTTPClient } from "@codat/platform/lib/http";

const dispatcher = new ProxyAgent("http://proxy.example.com:8080");

const httpClient = new HTTPClient({
  // 'fetcher' takes a function that has the same signature as native 'fetch'.
  fetcher: (input, init) =>
    // 'dispatcher' is specific to undici and not part of the standard Fetch API.
    fetch(input, { ...init, dispatcher } as RequestInit),
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new CodatPlatform({ httpClient: httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | ------------ | ------ | ------- | | authHeader | apiKey | API key |

To authenticate with the API the authHeader parameter must be set when initializing the SDK client instance. For example:

import { CodatPlatform } from "@codat/platform";

const codatPlatform = new CodatPlatform({
  authHeader: "Basic BASE_64_ENCODED(API_KEY)",
});

async function run() {
  const result = await codatPlatform.companies.list({
    query: "id=e3334455-1aed-4e71-ab43-6bccf12092ee",
    orderBy: "-modifiedDate",
    tags: "region=uk && team=invoice-finance",
  });

  console.log(result);
}

run();

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { CodatPlatform } from "@codat/platform";

const sdk = new CodatPlatform({ debugLogger: console });

Support

If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. You can raise any issues by contacting your dedicated Codat representative or reaching out to our support team. We're here to help ensure a smooth experience for you.

Library generated by Speakeasy