L'API de Trak

Notre API authentifie les utilisateurs à l'aide de la norme OAuth Client Credentials. Cela signifie qu'un ID client et un Client secret sont échangés contre un jeton qui peut être utilisé pour effectuer des demandes.

ID client - L'identifiant unique constituant la première moitié de votre clé.

Client Secret - Une clé secrète utilisée pour vérifier l'identité de votre application.

Nous vous recommandons d'utiliser la bibliothèque client OAuth standard de l'industrie pour votre pile afin de gérer les échanges clé-jeton.

1. Obtenez un identifiant client et une clé secrète client auprès du Groupe Trak

2. Obtenez un jeton en utilisant /oauth/token

3. Soumettez une demande avec le forfait souhaité et/ou les services à la demande en utilisant /v1/service-request. Vous devrez transmettre le token généré à l'étape 2 dans l'en-tête de la requête en utilisant Autorisation : Bearer

4. L'url de l'api est api.groupetrak.com

Authentification

POST /oauth/token

Request Body

Name	Type	Description
client_id*	String
client_secret*	String
	String

200: OK

json { "token_type": "Bearer", "expires_in": 31536000, "access_token": "aaaabbbbbbcccccccccc" }

401: Unauthorized

json { "error": "invalid_client", "error_description": "Client authentication failed", "message": "Client authentication failed" }

**Exemple**

```json
{
    "grant_type":"client_credentials",
    "client_id":"aaaaaaaa-bbbb-cccc-ddddd-eeeeeeeeeeee",
    "client_secret":"ABcdeFgh"
}

Création d'une demande de service

POST /v1/service-request

200: OK

{ "ID": "5eac9fe5-d2df-4aa5-9b0a-b96942920378", "Date": "2021-02-25T18:49:19.000000Z", "FileNumber": "P20210200007", "Candidate": { "FirstName": "John", "LastName": "Smith", "DOB": "none" }, "Requestor": { "Enterprise": "AA TEST Company", "Name": "API User" }, "BundleAndServices": { "Bundle": "On-demand services only", "OnDemandServices": [ "Personal References(2)", "Medical Assessment" ] } }

400: Bad Request

{"data":
    {
        "RequesterFirstName": "Jill",
        "RequesterLastName": "Rogers",
        "RequesterEmail": "[e-mail]",
        "RequesterPhone": "[phone]",
        "RequesterLang": "en",
        "CandidateFirstName": "John",
        "CandidateLastName": "Smith",
        "ElectronicConsent": true,
        "Urgent": false,
        "Services": [
            {
                "Code": "PRO1"
            }
        ],
        "CandidateEmail": "[e-mail]",
        "CandidatePhone": "5195555555",
        "Lang": "en",
        "Comments": "Test Comments",
        "MedicalEvaluation": false
    }
}

var data = '{"data":\r\n    {\r\n    \t"RequesterFirstName": "Jill",\r\n\t    "RequesterLastName": "Rogers",\r\n        "RequesterEmail": "[e-mail]",\r\n        "RequesterPhone": "[phone]",\r\n        "RequesterLang": "en",\r\n        "CandidateFirstName": "John",\r\n        "CandidateLastName": "Smith",\r\n        "ElectronicConsent": false,\r\n        "Urgent": false,\r\n        "CandidateEmail": "[e-mail]",\r\n        "CandidatePhone": "5195555555",\r\n        "CandidateCellPhone": "5195555555",\r\n        "CandidateBirthdate": "1990-01-01",\r\n        "Lang": "en",\r\n        "Comments": "Test Comments",\r\n        "ReferenceGrid": "SHORT",\r\n        "Services": [\r\n            {\r\n                "Code": "RP",\r\n                "Count": 1\r\n            }\r\n        ],\r\n        "PersonalReference": [\r\n            {\r\n                "Name": "John Smith",\r\n                "Relation": "Co-worker",\r\n                "Phone": "5195555555",\r\n                "Email": "[e-mail]",\r\n                "Years": "5"\r\n            }\r\n        ]\r\n    }\r\n}';

var config = {
    method: 'post',
    maxBodyLength: Infinity,
    url: 'http://api.groupetrak.com/api/v1/service-request',
    headers: {
        'Authorization': 'Bearer <token>',
        'Content-Type': 'text/plain'
    },
    data : data
};

axios(config)
    .then(function (response) {
        console.log(JSON.stringify(response.data));
    })
    .catch(function (error) {
        console.log(error);
    });
```

Liste des forfaits

Renvoie une liste des forfaits auxquels vous avez accès

GET /v1/bundles

Des services à la demande peuvent être ajoutés à la demande en remplissant l'objet Services dans les données de la demande ; ce sera un éventail de services que vous souhaitez ajouter à la demande. Les services à la demande peuvent être de deux types : booléen et numérique. Pour les services booléens, il vous suffit d'inclure le code du service.

Si vous avez déjà sélectionné un forfait contenant un service booléen, vous ne devez pas l'ajouter également en tant que service à la demande. Pour les services numériques, vous devrez également inclure une propriété Count pour indiquer le nombre de services dont vous avez besoin.

200: OK

Demander une vérification de crédit (un service booléen) nécessiterait les éléments suivants :

{"data":
    {
        "CandidateFirstName": "John",
        "CandidateLastName": "Smith",
        "Services": [
            {
                "Code": "CDT"
            }
        ],
        "Lang": "en"
  }
}

Demander la vérification des emplois antérieurs (un service numérique) nécessiterait les éléments suivants :

{"data":
    {
        "CandidateFirstName": "John",
        "CandidateLastName": "Smith",
        "Services": [
            {
                "Code": "REF",
                "Count": "1"
            }
        ],
        "Lang": "en"
  }
}

Liste des services

Renvoie une liste des services à la carte auxquels vous avez accès

GET /v1/services

Etrak

{"data":
    {
        "CandidateFirstName": "John",
        "CandidateLastName": "Smith",
        "CandidateBirthdate": "1990-01-01",
        "ElectronicConsent": true,
        "Bundle": "PRO1",
        "CandidateEmail": "[e-mail]",
        "CandidateCellPhone": "5195555555",
        "Lang": "en"
    }
}

Demande urgente

{"data":
    {
        "CandidateFirstName": "John",
        "CandidateLastName": "Smith",
        "CandidateBirthdate": "1990-01-01",
        "ElectronicConsent": true,
        "Urgent": true,
        "Bundle": "COMPLETE",
        "CandidateEmail": "[e-mail]",
        "CandidateCellPhone": "5195555555",
        "Lang": "en"
    }
}

Ajouter un fichier

POST /v1/upload-file/{request_id}

Type ('consent', 'cipc_consent', 'identity', 'diploma', 'cv', 'reference', 'medical_survey', 'resume_tasks', 'goods', 'police_certificate')

File (send as form data)

$token = '<api-token>';

    $url = DIS_API_URL . '/api/v1/upload-file/' . $request_id;

    $curl = curl_init();
    $curl_data = [];
    $curl_data['Type'] = 'consent';
    $curl_data['file'] = new CURLFILE($file_path);

    curl_setopt_array($curl, array(
        CURLOPT_URL => $url,
        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 => $curl_data,
        CURLOPT_HTTPHEADER => array(
            'Authorization: Bearer ' . $token
        ),
    ));

    $response = curl_exec($curl);

    curl_close($curl);

Liste des demandes de service

GET /v1/service-requests`

[
    {
        "ID": "5eac9fe5-d2df-4aa5-9b0a-b96942920378",
        "Date": "2021-02-25T18:49:19.000000Z",
        "FileNumber": "P20210200007",
        "Candidate": {
            "FirstName": "John",
            "LastName": "Smith",
            "DOB": "none"
        },
        "Requestor": {
            "Enterprise": "AA TEST Company",
            "Name": "API User"
        },
        "BundleAndServices": {
            "Bundle": "On-demand services only",
            "ReplaceQuebecWithCanada": false,
            "OnDemandServices": [
                "Personal Reference(3)"
            ],
        }
    },
    {
        "ID": "5eac9fe5-d2df-4aa5-9b0a-b96942920378",
        "Date": "2021-02-25T18:49:19.000000Z",
        "FileNumber": "P20210200007",
        "Candidate": {
            "FirstName": "John",
            "LastName": "Smith",
            "DOB": "none"
        },
        "Requestor": {
            "Enterprise": "AA TEST Company",
            "Name": "API User"
        },
        "BundleAndServices": {
            "Bundle": "On-demand services only",
            "ReplaceQuebecWithCanada": false,
            "OnDemandServices": [
                "Personal Reference(3)"
            ],
        }
    }
]