Insightly Tests

create_contact.php

<?php

$apiEndpoint = 'https://api.na1.insightly.com/v3.1/Contacts';
$apiKey = 'your-api-key';

//
// Create a new contact
//

$data = [
    'FIRST_NAME' => 'Jane',
    'LAST_NAME' => 'Doe',
    'EMAIL_ADDRESS' => '[email protected]'
];

$options = [
    CURLOPT_URL => $apiEndpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data),
];

$curl = curl_init();
curl_setopt_array($curl, $options);
$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);

$contactId = $data['CONTACT_ID'];
echo 'Contact Id: ' . $contactId . PHP_EOL . PHP_EOL;

//
// Get the contact by ID
//

$getOptions = array(
    CURLOPT_URL => $apiEndpoint . '/' . $contactId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    )
);

$getCurl = curl_init();
curl_setopt_array($getCurl, $getOptions);
$getResponse = curl_exec($getCurl);
curl_close($getCurl);

echo 'Contact GET by id' . $getResponse . PHP_EOL . PHP_EOL;

//
// Search the contact by email address
//

$getOptions = array(
    CURLOPT_URL => $apiEndpoint . '/' . 'Search?field_name=EMAIL_ADDRESS&field_value=jane.doe%40anonymous&top=1',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    )
);

$getCurl = curl_init();
curl_setopt_array($getCurl, $getOptions);
$getResponse = curl_exec($getCurl);
curl_close($getCurl);

if ($getResponse = '[]') {
    echo '!!! NOTHING FOUND BY EMAIL BUT FOUND BY ID !!!' . PHP_EOL . PHP_EOL;
} else {
    echo 'Contact found by email: ' . $getResponse . PHP_EOL . PHP_EOL;
}

//
// Delete the contact
//

$deleteOptions = [
    CURLOPT_URL => $apiEndpoint . '/' . $contactId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ]
];

$deleteCurl = curl_init();
curl_setopt_array($deleteCurl, $deleteOptions);
$deleteResponse = curl_exec($deleteCurl);
curl_close($deleteCurl);

echo $deleteResponse;

link_contact.php

<?php

$contactsEndpoint = 'https://api.na1.insightly.com/v3.1/Contacts/';
$opportunitiesEndpoint = 'https://api.na1.insightly.com/v3.1/Opportunities/';
$apiKey = 'your-api-key';

//
// Create a new opportunity
//

$data = [
    'OPPORTUNITY_NAME' => 'Test opportunity',
    'OPPORTUNITY_STATE' => 'Open',
    'OPPORTUNITY_DETAILS' => 'Test oppportunity details',
];

$options = [
    CURLOPT_URL => $opportunitiesEndpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data),
];

$curl = curl_init();
curl_setopt_array($curl, $options);
$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);

$opportunityId = $data['OPPORTUNITY_ID'];
echo 'Opportunity Id: ' . $opportunityId . PHP_EOL . PHP_EOL;

//
// Create a new contact
//

$data = [
    'FIRST_NAME' => 'Jane',
    'LAST_NAME' => 'Doe',
    'EMAIL_ADDRESS' => '[email protected]'
];

$options = [
    CURLOPT_URL => $contactsEndpoint,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data),
];

$curl = curl_init();
curl_setopt_array($curl, $options);
$response = curl_exec($curl);
curl_close($curl);

$data = json_decode($response, true);

$contactId = $data['CONTACT_ID'];
echo 'Contact Id: ' . $contactId . PHP_EOL . PHP_EOL;

//
// Link the contact to the opportunity
//

$data = [
    'LINK_OBJECT_ID' => $contactId,
    'LINK_OBJECT_NAME' => 'contact',
];

$options = [
    CURLOPT_URL => $opportunitiesEndpoint . $opportunityId . '/Links',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data),
];

$curl = curl_init();
curl_setopt_array($curl, $options);
$response = curl_exec($curl);
curl_close($curl);

echo 'Link response: ' . $response  . PHP_EOL . PHP_EOL;


//
// Get the opportunity to verify link
//

$getOptions = array(
    CURLOPT_URL => $opportunitiesEndpoint . '/' . $opportunityId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => array(
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    )
);

$getCurl = curl_init();
curl_setopt_array($getCurl, $getOptions);
$getResponse = curl_exec($getCurl);
$data = json_decode($getResponse, true);
curl_close($getCurl);

if (!isset($data['LINKS'][0])) {
    echo '!!! No links found !!!' . PHP_EOL . PHP_EOL;
} else {
    echo 'Link found: ' . $data['LINKS'][0]['LINK_OBJECT_ID'] . PHP_EOL . PHP_EOL;
}

//
// Delete the contact
//

$deleteOptions = [
    CURLOPT_URL => $contactsEndpoint . '/' . $contactId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ]
];

$deleteCurl = curl_init();
curl_setopt_array($deleteCurl, $deleteOptions);
$deleteResponse = curl_exec($deleteCurl);
curl_close($deleteCurl);

echo $deleteResponse;

//
// Delete the opportunity
//

$deleteOptions = [
    CURLOPT_URL => $opportunitiesEndpoint . '/' . $opportunityId,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Basic ' . base64_encode($apiKey . ':'),
        'Content-Type: application/json'
    ]
];

$deleteCurl = curl_init();
curl_setopt_array($deleteCurl, $deleteOptions);
$deleteResponse = curl_exec($deleteCurl);
curl_close($deleteCurl);

echo $deleteResponse;

Replace your-api-key

Scenario 1: searching on e-mail

Steps:

• Create a contact and store the id
• Getting the contact by id will always work
• Searching the contact by email will sometimes fail (1 out of 10 executions will fail). Even adding a timeout of 5 seconds can result in failure.

Scenario 2: linking a contact to an opportunity

Steps:

• Create an opportunity and store the id
• Create a contact and store the id
• Link the contact to the opportunity
• Get the opportunity by id and sometimes the link will be missing even when the previous call was successful (1 out of 10 executions will fail). Even adding a timeout of 5 seconds can result in failure.

Problem

How can we build a polling mechanism to cover these failures?