Manage the building blocks of Codat, including companies, connections, and more.
npm add @codat/platform
yarn add @codat/platform
import { CodatPlatform } from "@codat/platform";
async function run() {
const sdk = new CodatPlatform({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
- createApiKey - Create API key
- deleteApiKey - Delete API key
- getProfile - Get profile
- getSyncSettings - Get sync settings
- listApiKeys - List API keys
- updateProfile - Update profile
- updateSyncSettings - Update all sync settings
- create - Create company
- delete - Delete a company
- get - Get company
- list - List companies
- update - Update company
- create - Create connection
- delete - Delete connection
- get - Get connection
- list - List connections
- unlink - Unlink connection
- updateAuthorization - Update authorization
- configure - Configure custom data type
- getConfiguration - Get custom data configuration
- list - List custom data type records
- refresh - Refresh custom data type
- getModelOptions - Get push options
- getOperation - Get push operation
- listOperations - List push operations
- all - Refresh all data
- byDataType - Refresh data type
- get - Get data status
- getPullOperation - Get pull operation
- listPullOperations - List pull operations
- addCompany - Add company
- create - Create group
- list - List groups
- removeCompany - Remove company
- get - Get integration
- getBranding - Get branding
- list - List integrations
- configure - Configure
- getConfiguration - Get configuration
-
create- Create webhook⚠️ Deprecated - createConsumer - Create webhook consumer
- deleteConsumer - Delete webhook consumer
-
get- Get webhook⚠️ Deprecated -
list- List webhooks⚠️ Deprecated - listConsumers - List webhook consumers
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";
async function run() {
const sdk = new CodatPlatform({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey(
{
name: "azure-invoice-finance-processor",
},
{
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
}
);
if (res.statusCode == 200) {
// handle response
}
}
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";
async function run() {
const sdk = new CodatPlatform({
retry_config: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
Error Object | Status Code | Content Type |
---|---|---|
errors.SDKError | 4xx-5xx | / |
Example
import { CodatPlatform } from "@codat/platform";
async function run() {
const sdk = new CodatPlatform({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
let res;
try {
res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
} catch (err) {
if (err instanceof errors.SDKError) {
console.error(err); // handle exception
throw err;
}
}
if (res.statusCode == 200) {
// handle response
}
}
run();
You can override the default server globally by passing a server index to the serverIdx: number
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.codat.io |
None |
import { CodatPlatform } from "@codat/platform";
async function run() {
const sdk = new CodatPlatform({
serverIdx: 0,
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
The default server can also be overridden globally by passing a URL to the serverURL: str
optional parameter when initializing the SDK client instance. For example:
import { CodatPlatform } from "@codat/platform";
async function run() {
const sdk = new CodatPlatform({
serverURL: "https://api.codat.io",
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
The Typescript SDK makes API calls using the axios HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom AxiosInstance
object.
For example, you could specify a header for every request that your sdk makes as follows:
import { @codat/platform } from "CodatPlatform";
import axios from "axios";
const httpClient = axios.create({
headers: {'x-custom-header': 'someValue'}
})
const sdk = new CodatPlatform({defaultClient: httpClient});
This SDK supports the following security scheme globally:
Name | Type | Scheme |
---|---|---|
authHeader |
apiKey | API key |
You can set the security parameters through the security
optional parameter when initializing the SDK client instance. For example:
import { CodatPlatform } from "@codat/platform";
async function run() {
const sdk = new CodatPlatform({
security: {
authHeader: "Basic BASE_64_ENCODED(API_KEY)",
},
});
const res = await sdk.settings.createApiKey({
name: "azure-invoice-finance-processor",
});
if (res.statusCode == 200) {
// handle response
}
}
run();
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.