API Catalogue
API Documentation
API Introduction
The Cargo Insurance API provides seamless integration for obtaining cargo insurance coverage online. With this API, users can efficiently manage and insure their shipments, ensuring peace of mind and financial protection against potential losses during transit. The API is accessed via a POST request to the base URL https://cargoinsureonline.com/wp-json/api/v1, and requires authentication through the headers X-API-Key: API_KEY and X-API-Sec: API_SEC. This streamlined approach allows for quick and secure insurance processing, tailored to the needs of modern logistics operations.
Base Url: https://cargoinsureonline.com/wp-json/api/v1
Herader
X-API-Key: API_KEY
X-API-Sec: API_SEC
Method: POST
Get Global Variables
The Get Global Variable Data API provides essential information on countries, currencies, and group types, which are crucial for global logistics and shipping operations.
Endpoint: /get-vars
cURL
JavaScript
PHP
cURL
curl –location –request POST ‘https://cargoinsureonline.com/wp-json/api/v1/get-vars’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
const formdata = new FormData();
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: formdata,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-vars”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-vars’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Get Sub-Group
The Get Sub-Group API allows users to retrieve specific sub-group information based on a given main group, enhancing the granularity and precision of cargo classification. By accessing the endpoint /get-sub-group, users can send a POST request with the main group details to obtain relevant sub-group data.
Endpoint: /get-sub-group
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/get-sub-group’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“main_group”:”General Cargo of non-fragile or lower theft nature”
}’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“main_group”: “General Cargo of non-fragile or lower theft nature”
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-sub-group”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-sub-group’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“main_group”:”General Cargo of non-fragile or lower theft nature”
}’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’,
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Get Countries
The Get Countries API provides a comprehensive list of countries, essential for international logistics and insurance processes. By accessing the endpoint /get-countries, users can send a POST request to retrieve detailed country data.
Endpoint: /get-countries
cURL
JavaScript
PHP
cURL
curl –location –request POST ‘https://cargoinsureonline.com/wp-json/api/v1/get-countries’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–data ”
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
const raw = “”;
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-countries”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-countries’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Get Currencies
The Get Currencies API provides users with a detailed list of global currencies, essential for international trade and financial transactions. By accessing the endpoint /get-currencies, users can send a POST request to retrieve comprehensive currency data.
Endpoint: /get-currencies
cURL
JavaScript
PHP
cURL
curl –location –request POST ‘https://cargoinsureonline.com/wp-json/api/v1/get-currencies’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–data ”
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
const raw = “”;
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-currencies”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-currencies’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Get Country Description
The Get Country Description API provides detailed descriptions of specific countries, essential for understanding various aspects of international destinations. By accessing the endpoint /get-country-desc, users can send a POST request with the names or codes of the countries to retrieve comprehensive information about them.
Endpoint: /get-country-desc
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/get-country-desc’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“from_country”:”Switzerland”,
“to_country”:”France”
}’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“from_country”: “Switzerland”,
“to_country”: “France”
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-country-desc”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-country-desc’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“from_country”:”Switzerland”,
“to_country”:”France”
}’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Get Insurance Rate
The Get Insurance Rate API allows users to obtain precise insurance rate calculations for their shipments. By accessing the endpoint /get-rate, users can send a POST request with detailed shipment information, including the origin and destination countries, cargo details, currency, and total value.
Endpoint: /get-rate
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/get-rate’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“form_country”:”Switzerland”,
“to_country”:”France”,
“main_group”:”General Cargo of non-fragile or lower theft nature”,
“sub_group”:”Air”,
“currency”:”CHF”,
“total_value”:1000,
“extra_expense”:100,
“certificate”: false
}’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“form_country”: “Switzerland”,
“to_country”: “France”,
“main_group”: “General Cargo of non-fragile or lower theft nature”,
“sub_group”: “Air”,
“currency”: “CHF”,
“total_value”: 1000,
“extra_expense”: 100,
“certificate”: false
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/get-rate”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/get-rate’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“form_country”:”Switzerland”,
“to_country”:”France”,
“main_group”:”General Cargo of non-fragile or lower theft nature”,
“sub_group”:”Air”,
“currency”:”CHF”,
“total_value”:1000,
“extra_expense”:100,
“certificate”: false
}’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Buy Cargo Insurance
The Buy Insurance API enables users to purchase cargo insurance for their shipments efficiently. By accessing the endpoint /buy-cargo-insurance, users can send a POST request with detailed shipment and client information to secure the necessary insurance coverage. This API streamlines the process of obtaining cargo insurance, ensuring timely and accurate protection for shipments.
Endpoint: /buy-cargo-insurance
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data-raw ‘{
“from_country”:”Switzerland”,
“to_country”:”France”,
“main_group”:”General Cargo of non-fragile or lower theft nature”,
“sub_group”:”Air”,
“currency”:”CHF”,
“total_value”:1000,
“extra_expense”:100,
“client_name”:”TEST TEST”,
“awb_or_bl_or_vessel_name”:”TEST TEST”,
“etd”:”30/05/2024″,
“cargo_description”:”TEST TEST TEST TEST TEST”,
“client_email”:”example@gmail.com”,
“certificate”: false,
“company_name”:”Example Company”
}’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“from_country”: “Switzerland”,
“to_country”: “France”,
“main_group”: “General Cargo of non-fragile or lower theft nature”,
“sub_group”: “Air”,
“currency”: “CHF”,
“total_value”: 1000,
“extra_expense”: 100,
“client_name”: “TEST TEST”,
“awb_or_bl_or_vessel_name”: “TEST TEST”,
“etd”: “30/05/2024”,
“cargo_description”: “TEST TEST TEST TEST TEST”,
“client_email”: “example@gmail.com”,
“certificate”: false,
“company_name”: “Example Company”
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“from_country”:”Switzerland”,
“to_country”:”France”,
“main_group”:”General Cargo of non-fragile or lower theft nature”,
“sub_group”:”Air”,
“currency”:”CHF”,
“total_value”:1000,
“extra_expense”:100,
“client_name”:”TEST TEST”,
“awb_or_bl_or_vessel_name”:”TEST TEST”,
“etd”:”30/05/2024″,
“cargo_description”:”TEST TEST TEST TEST TEST”,
“client_email”:”example@gmail.com”,
“certificate”: false,
“company_name”:”Example Company”
}’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Buy Cargo Insurance For Ecommerce
The Buy E-Commerce Cargo Insurance API is specifically designed for insuring e-commerce shipments. By accessing the endpoint /buy-cargo-insurance, users can send a POST request with detailed shipment, client, and product information to secure insurance coverage for e-commerce packages.
Endpoint: /buy-cargo-insurance
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“total_value”: 1000,
“extra_expense”:0,
“currency”: “USD”,
“first_name”: “John”,
“last_name”: “Doe”,
“client_email”: “example@gmail.com”,
“company_name”: “Example Company”,
“full_address”: “123 Example St, City, Country”,
“carrier_name”: “Example Carrier”,
“tracking_number”: “123456789”,
“from_country”: “Origin Country”,
“to_country”: “Destination Country”,
“internal_reference”: “123456”,
“cart_data”: {
“item1”: {
“name”: “Product 1”,
“quantity”: 2,
“price”: 50
},
“item2”: {
“name”: “Product 2”,
“quantity”: 1,
“price”: 100
}
},
“lang”: “en”,
“etd”: “2024-04-20”,
“sub_group”: “Air”,
“freight_forwarder”: “Example Forwarder”,
“cargo_description”: “Description of the cargo”,
“main_group”: “E-Commerce Shipments”
}
‘
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“total_value”: 1000,
“extra_expense”: 0,
“currency”: “USD”,
“first_name”: “John”,
“last_name”: “Doe”,
“client_email”: “example@gmail.com”,
“company_name”: “Example Company”,
“full_address”: “123 Example St, City, Country”,
“carrier_name”: “Example Carrier”,
“tracking_number”: “123456789”,
“from_country”: “Origin Country”,
“to_country”: “Destination Country”,
“internal_reference”: “123456”,
“cart_data”: {
“item1”: {
“name”: “Product 1”,
“quantity”: 2,
“price”: 50
},
“item2”: {
“name”: “Product 2”,
“quantity”: 1,
“price”: 100
}
},
“lang”: “en”,
“etd”: “2024-04-20”,
“sub_group”: “Air”,
“freight_forwarder”: “Example Forwarder”,
“cargo_description”: “Description of the cargo”,
“main_group”: “E-Commerce Shipments”
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/buy-cargo-insurance’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“total_value”: 1000,
“extra_expense”:0,
“currency”: “USD”,
“first_name”: “John”,
“last_name”: “Doe”,
“client_email”: “example@gmail.com”,
“company_name”: “Example Company”,
“full_address”: “123 Example St, City, Country”,
“carrier_name”: “Example Carrier”,
“tracking_number”: “123456789”,
“from_country”: “Origin Country”,
“to_country”: “Destination Country”,
“internal_reference”: “123456”,
“cart_data”: {
“item1”: {
“name”: “Product 1”,
“quantity”: 2,
“price”: 50
},
“item2”: {
“name”: “Product 2”,
“quantity”: 1,
“price”: 100
}
},
“lang”: “en”,
“etd”: “2024-04-20”,
“sub_group”: “Air”,
“freight_forwarder”: “Example Forwarder”,
“cargo_description”: “Description of the cargo”,
“main_group”: “E-Commerce Shipments”
}
‘,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
Cancel Insurance
The Cancel Insurance API allows users to cancel an existing cargo insurance policy efficiently. By accessing the endpoint /cancel-insurance, users can send a POST request with the policy number to terminate the insurance coverage.
Endpoint: /cancel-insurance
cURL
JavaScript
PHP
cURL
curl –location ‘https://cargoinsureonline.com/wp-json/api/v1/cancel-insurance’ \
–header ‘X-API-Key: API_KEY ‘ \
–header ‘X-API-Sec: API_SEC’ \
–header ‘Content-Type: application/json’ \
–data ‘{
“policy_no”:”Your_policy_no”
}’
JavaScript
const myHeaders = new Headers();
myHeaders.append(“X-API-Key”, “API_KEY “);
myHeaders.append(“X-API-Sec”, “API_SEC”);
myHeaders.append(“Content-Type”, “application/json”);
const raw = JSON.stringify({
“policy_no”: “Your_policy_no”
});
const requestOptions = {
method: “POST”,
headers: myHeaders,
body: raw,
redirect: “follow”
};
fetch(“https://cargoinsureonline.com/wp-json/api/v1/cancel-insurance”, requestOptions)
.then((response) => response.text())
.then((result) => console.log(result))
.catch((error) => console.error(error));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => ‘https://cargoinsureonline.com/wp-json/api/v1/cancel-insurance’,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => ”,
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => ‘POST’,
CURLOPT_POSTFIELDS =>'{
“policy_no”:”Your_policy_no”
}’,
CURLOPT_HTTPHEADER => array(
‘X-API-Key: API_KEY ‘,
‘X-API-Sec: API_SEC’,
‘Content-Type: application/json’
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;