Skip to content

Getting Started with Adaptix API

Adaptix provides a comprehensive REST API suite for managing contact records and retrieving information on various Adaptix entities. Refer to the following example of how to fetch a contact record using the API.

Install it via Composer

To install using composer, simply run composer require adaptix/api-library:dev-main.

Also run, composer require psr/log:^1.1.

Then use the following PHP code snippet to fetch a contact record using the API.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
<?php

require_once __DIR__.'/vendor/autoload.php';

use Adaptix\AdaptixApi;
use Adaptix\Auth\ApiAuth;

// Basic Auth setttings
$settings = [
    'userName'   => '',             // Create a new user       
    'password'   => '',             // Make it a secure password
];

$initAuth   = new ApiAuth();
$auth       = $initAuth->newAuth($settings, 'BasicAuth');
$apiUrl     = "https://instancename.adaptix.ai/api";
$api        = new AdaptixApi();
$contactApi = $api->newApi("contacts", $auth, $apiUrl);
$contact = $contactApi->get($id);

Here, the instancename in the url should be replaced with your adaptix instance name.

The above code snippet gives you the following (as sample) JSON output,

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
"contact": {
    "id": 47,
    "dateAdded": "2015-07-21T12:27:12-05:00",
    "createdBy": 1,
    "createdByUser": "Joe Smith",
    "dateModified": "2015-07-21T14:12:03-05:00",
    "modifiedBy": 1,
    "modifiedByUser": "Joe Smith",
    "owner": {
        "id": 1,
        "username": "joesmith",
        "firstName": "Joe",
        "lastName": "Smith"
    },
    "points": 10,
    "lastActive": "2015-07-21T14:19:37-05:00",
    "dateIdentified": "2015-07-21T12:27:12-05:00",
    "color": "ab5959",
    "ipAddresses": {
        "111.111.111.111": {
            "ipAddress": "111.111.111.111",
            "ipDetails": {
                "city": "",
                "region": "",
                "country": "",
                "latitude": "",
                "longitude": "",
                "isp": "",
                "organization": "",
                "timezone": ""
            }
        }
    },
    "fields": {
        "core": {
            "title": {
                "id": "1",
                "label": "Title",
                "alias": "title",
                "type": "lookup",
                "group": "core",
                "value": "Mr"
            },
            "firstname": {
                "id": "2",
                "label": "First Name",
                "alias": "firstname",
                "type": "text",
                "group": "core",
                "value": "Jim"
            },

            "...": {
                "..." : "..."
            }

        },
        "social": {
            "twitter": {
                "id": "17",
                "label": "Twitter",
                "alias": "twitter",
                "type": "text",
                "group": "social",
                "value": "jimcontact"
            },

            "...": {
                "..." : "..."
            }

        },
        "personal": [],
        "professional": [],
        "all": {
            "title": "Mr",
            "firstname": "Jim",
            "twitter": "jimcontact",

            "...": "..."
        }
    }
}

For more details, Please see developer documentation.