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 polygonRiskRequest = {
  "geoJson": {}
};
const response = await client.riskManagement.assessPolygonRisk(polygonRiskRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import PolygonRiskRequest

client = AgriBackupClient('sk_live_...')
polygon_risk_request = PolygonRiskRequest(geo_json={})
response = client.risk_management.assess_polygon_risk(polygon_risk_request=polygon_risk_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.PolygonRiskRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var polygonRiskRequest = new PolygonRiskRequest()
    .geo_json({});
var response = client.riskManagement.assessPolygonRisk(polygonRiskRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var polygonRiskRequest = new PolygonRiskRequest {
    GeoJson = {}
};
var response = await client.RiskManagement.AssessPolygonRiskAsync(polygonRiskRequest);
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 coordinateRiskRequest = {
  "latitude": -1.2921,
  "longitude": 36.8219
};
const response = await client.riskManagement.assessCoordinateRisk(coordinateRiskRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import CoordinateRiskRequest

client = AgriBackupClient('sk_live_...')
coordinate_risk_request = CoordinateRiskRequest(latitude=-1.2921, longitude=36.8219)
response = client.risk_management.assess_coordinate_risk(coordinate_risk_request=coordinate_risk_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.CoordinateRiskRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var coordinateRiskRequest = new CoordinateRiskRequest()
    .latitude(-1.2921)
    .longitude(36.8219);
var response = client.riskManagement.assessCoordinateRisk(coordinateRiskRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var coordinateRiskRequest = new CoordinateRiskRequest {
    Latitude = -1.2921,
    Longitude = 36.8219
};
var response = await client.RiskManagement.AssessCoordinateRiskAsync(coordinateRiskRequest);
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 tracesCredentialRequest = {
  "tokenOrPassword": "secret_abc123",
  "username": "eudr_enterprise_user"
};
const response = await client.credentials.ingestTracesCredentials(tracesCredentialRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import TracesCredentialRequest

client = AgriBackupClient('sk_live_...')
traces_credential_request = TracesCredentialRequest(token_or_password="secret_abc123", username="eudr_enterprise_user")
response = client.credentials.ingest_traces_credentials(traces_credential_request=traces_credential_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.TracesCredentialRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var tracesCredentialRequest = new TracesCredentialRequest()
    .token_or_password("secret_abc123")
    .username("eudr_enterprise_user");
var response = client.credentials.ingestTracesCredentials(tracesCredentialRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var tracesCredentialRequest = new TracesCredentialRequest {
    TokenOrPassword = "secret_abc123",
    Username = "eudr_enterprise_user"
};
var response = await client.Credentials.IngestTracesCredentialsAsync(tracesCredentialRequest);
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();
console.log(response.data);

Python

from agribackup import AgriBackupClient

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

Java

import com.agribackup.AgriBackupClient;

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

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Credentials.DeleteTracesCredentialsAsync();
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();
console.log(response.data);

Python

from agribackup import AgriBackupClient

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

Java

import com.agribackup.AgriBackupClient;

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

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.ListApiKeysAsync();
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 apiKeyCreateRequest = {
  "name": "Default Sandbox Key",
  "scopes": [
    "[\"*\"]"
  ]
};
const response = await client.apiKeys.createApiKey(apiKeyCreateRequest);
console.log(response.data);

Python

from agribackup import AgriBackupClient
from agribackup.models import ApiKeyCreateRequest

client = AgriBackupClient('sk_live_...')
api_key_create_request = ApiKeyCreateRequest(name="Default Sandbox Key", scopes=["["*"]"])
response = client.api_keys.create_api_key(api_key_create_request=api_key_create_request)
print(response)

Java

import com.agribackup.AgriBackupClient;
import com.agribackup.model.ApiKeyCreateRequest;
import java.util.Arrays;

AgriBackupClient client = new AgriBackupClient("sk_live_...");
var apiKeyCreateRequest = new ApiKeyCreateRequest()
    .name("Default Sandbox Key")
    .scopes(Arrays.asList("["*"]"));
var response = client.apiKeys.createApiKey(apiKeyCreateRequest);
System.out.println(response);

C#

using AgriBackup;
using AgriBackup.Model;
using System.Collections.Generic;

var client = new AgriBackupClient("sk_live_...");
var apiKeyCreateRequest = new ApiKeyCreateRequest {
    Name = "Default Sandbox Key",
    Scopes = new List<string> { "["*"]" }
};
var response = await client.ApiKeys.CreateApiKeyAsync(apiKeyCreateRequest);
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('keyId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

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

Java

import com.agribackup.AgriBackupClient;

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

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.ApiKeys.RotateApiKeyAsync("keyId");
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();
console.log(response.data);

Python

from agribackup import AgriBackupClient

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

Java

import com.agribackup.AgriBackupClient;

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

C#

using AgriBackup;

var client = new AgriBackupClient("sk_live_...");
var response = await client.Credentials.GetTracesCredentialsStatusAsync();
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('keyId');
console.log(response.data);

Python

from agribackup import AgriBackupClient

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

Java

import com.agribackup.AgriBackupClient;

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

C#

using AgriBackup;

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