1. Pre-Assessment & Authentication

The following methods are available via the AgriBackup SDK for this integration stage.

Assess risk by polygon (Pre-Assessment)

Runs Country Risk Matrix lookups and satellite Sentinel-2 deforestation analysis on-the-fly for a GeoJSON polygon.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.riskManagement.assessPolygonRisk(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.risk_management.assess_polygon_risk(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.riskManagement.assessPolygonRisk(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.RiskManagement.AssessPolygonRiskAsync(/* args */);
Console.WriteLine(response);

Assess risk by coordinate (Pre-Assessment)

Runs Country Risk Matrix lookups and satellite Sentinel-2 deforestation analysis on-the-fly for a coordinate, returning predictive risk metrics without registering a batch.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.riskManagement.assessCoordinateRisk(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.risk_management.assess_coordinate_risk(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.riskManagement.assessCoordinateRisk(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.RiskManagement.AssessCoordinateRiskAsync(/* args */);
Console.WriteLine(response);

Ingest TRACES NT Credentials into Vault

Accepts the raw TRACES NT API token/password, symmetrically encrypts it via HashiCorp Vault Transit Engine, and stores the resulting ciphertext reference.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.credentials.ingestTracesCredentials(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.credentials.ingest_traces_credentials(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.credentials.ingestTracesCredentials(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Credentials.IngestTracesCredentialsAsync(/* args */);
Console.WriteLine(response);

Revoke and purge TRACES NT credentials

Deletes the organization's TRACES NT credentials reference from the database, permanently revoking delegation. Due to our stateless transit-based encryption, clearing the ciphertext reference completely purges the secret from the system.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.credentials.deleteTracesCredentials(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.credentials.delete_traces_credentials(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.credentials.deleteTracesCredentials(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Credentials.DeleteTracesCredentialsAsync(/* args */);
Console.WriteLine(response);

List API Keys

Returns a list of all active API keys for the organization (without raw keys).

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.apiKeys.listApiKeys(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.api_keys.list_api_keys(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.apiKeys.listApiKeys(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.ListApiKeysAsync(/* args */);
Console.WriteLine(response);

Generate a new API Key

Generates a new secure API Key with defined scopes. Returns the raw key only once.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.apiKeys.createApiKey(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.api_keys.create_api_key(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.apiKeys.createApiKey(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.CreateApiKeyAsync(/* args */);
Console.WriteLine(response);

Rotate an API Key

Deactivates the old key and generates a new raw key with the same configuration.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.apiKeys.rotateApiKey(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.api_keys.rotate_api_key(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.apiKeys.rotateApiKey(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.RotateApiKeyAsync(/* args */);
Console.WriteLine(response);

Check TRACES NT credential delegation status

Verifies if the credentials registered in HashiCorp Vault for this organization are valid by executing a connection test to the TRACES NT SOAP API.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.credentials.getTracesCredentialsStatus(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.credentials.get_traces_credentials_status(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.credentials.getTracesCredentialsStatus(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Credentials.GetTracesCredentialsStatusAsync(/* args */);
Console.WriteLine(response);

Delete an API Key

Permanently removes an API key.

Node.js

import { AgriBackupClient } from 'agribackup';

const client = new AgriBackupClient('sk_live_...');
const response = await client.apiKeys.deleteApiKey(/* args */);
console.log(response.data);

Python

from agribackup import AgriBackupClient

client = AgriBackupClient('sk_live_...')
response = client.api_keys.delete_api_key(# args)
print(response)

Java

import com.agribackup.AgriBackupClient;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var response = client.apiKeys.deleteApiKey(/* args */);
System.out.println(response);

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.DeleteApiKeyAsync(/* args */);
Console.WriteLine(response);