Démarrage rapide
Dans ce tutoriel, vous reliez votre application à votre organisation bac à sable, ouvrez le dossier d’une vente immobilière avec ses deux clients, un acquéreur nommé Camille Durand SANCTION et un vendeur, lancez leurs analyses, et finissez par lire les trois alertes de sanctions que l’acquéreur a levées. Il vous faut un terminal et un navigateur, puis, pour le code, Node.js 20 ou plus récent, PHP 8.1 ou plus récent, ou curl seul. Les trois premières étapes se font dans le terminal, quel que soit le langage choisi.
Avant de commencer
Section intitulée « Avant de commencer »Il vous faut ce que votre compte développeur vous donne quand vous créez votre application dans sa console (ou LexOpti, quand il l’enregistre pour vous) :
- un compte LexOpti, créé avec l’adresse e-mail avec laquelle vous développez, propriétaire d’une organisation bac à sable ;
- un client OAuth : son
client_id, sonclient_secret(affiché une seule fois) et l’une de ses URI de redirection enregistrées. Ce tutoriel l’écrithttps://crm.example.com/oauth/callback: utilisez la vôtre à la place.
Les comptes développeur et professionnel sont distincts : si vous utilisez déjà LexOpti en tant que professionnel, demandez-les avec une autre adresse e-mail.
1. Préparer la paire PKCE
Section intitulée « 1. Préparer la paire PKCE »LexOpti exige toujours PKCE. Dans votre terminal, gardez les identifiants de votre client et tirez un vérificateur aléatoire, puis calculez son challenge :
export CLIENT_ID=YOUR_CLIENT_IDexport CLIENT_SECRET=YOUR_CLIENT_SECRETexport CODE_VERIFIER=$(openssl rand -base64 32 | tr '+/' '-_' | tr -d '=')export CODE_CHALLENGE=$(printf %s "$CODE_VERIFIER" | openssl dgst -sha256 -binary | openssl base64 | tr '+/' '-_' | tr -d '=')echo "$CODE_CHALLENGE"La dernière commande affiche un challenge de 43 caractères. Gardez ce terminal ouvert : les étapes suivantes utilisent ces variables.
2. Autoriser votre application
Section intitulée « 2. Autoriser votre application »Ouvrez cette adresse dans votre navigateur, avec votre client_id, votre URI de redirection et le challenge que vous venez d’afficher :
https://app.lexopti.com/api/auth/oauth2/authorize?response_type=code &client_id=YOUR_CLIENT_ID &redirect_uri=https://crm.example.com/oauth/callback &code_challenge=YOUR_CODE_CHALLENGE&code_challenge_method=S256 &scope=openid%20offline_access%20lexopti:read%20lexopti:write &resource=https://app.lexopti.com/v1&state=YOUR_STATEConnectez-vous avec votre compte développeur, choisissez votre organisation bac à sable et consentez. LexOpti renvoie votre navigateur vers votre URI de redirection avec code et state dans l’adresse. Votre rappel n’a pas besoin d’exister encore : copiez la valeur de code depuis la barre d’adresse, et utilisez-la aussitôt, car un code ne vaut que peu de temps et une seule fois.
3. Échanger le code contre des jetons
Section intitulée « 3. Échanger le code contre des jetons »export CODE=THE_CODE_YOU_COPIEDcurl https://app.lexopti.com/api/auth/oauth2/token \ -u "$CLIENT_ID:$CLIENT_SECRET" \ -d grant_type=authorization_code \ -d code="$CODE" \ -d code_verifier="$CODE_VERIFIER" \ -d redirect_uri=https://crm.example.com/oauth/callback \ -d resource=https://app.lexopti.com/v1LexOpti répond un objet JSON avec un access_token, valable 15 minutes (expires_in: 900), et un refresh_token. Gardez le jeton d’accès pour la suite du tutoriel :
export LEXOPTI_ACCESS_TOKEN=THE_ACCESS_TOKENcurl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" https://app.lexopti.com/v1/organizationLa réponse décrit votre organisation bac à sable, avec "sandbox": true : votre application agit désormais pour vous dans celle-ci.
4. Créer le dossier
Section intitulée « 4. Créer le dossier »Écrivez les étapes suivantes dans le langage de votre choix : les onglets montrent chacune en TypeScript avec le SDK, en PHP avec son extension curl et sans bibliothèque, ou avec curl dans le même terminal.
Dans LexOpti, une analyse se fait toujours dans un dossier (case dans l’API) : l’affaire, la mission ou l’opération pour laquelle elle est menée, avec sa nature et ses clients. Ici le dossier est une vente immobilière, un exemple que traitent bien des professions, de nature vente_immobiliere, pour deux clients, l’acquéreur et le vendeur. Un dossier nomme des clients existants : vous les créez d’abord (POST /v1/clients), puis le dossier (POST /v1/cases). SANCTION dans le nom de l’acquéreur donne un résultat de sanctions déterministe dans le bac à sable ; le nom du vendeur est propre. Chaque création envoie une Idempotency-Key (le SDK l’ajoute), pour qu’une nouvelle tentative ne crée jamais une seconde ressource.
Les natures dépendent de la profession de votre bac à sable : les avocats et les agents immobiliers proposent vente_immobiliere ; pour une autre profession, choisissez l’une des siennes (le bac à sable d’un expert-comptable peut prendre cession_parts_actions, par exemple), ou custom avec un type_label, que toutes les professions proposent, notaires compris.
Dans un nouveau dossier, installez le SDK :
npm install @lexopti/sdkEnregistrez ce script sous quickstart.mts :
import { createLexOptiClient } from "@lexopti/sdk"; const lexopti = createLexOptiClient({ accessToken: () => process.env.LEXOPTI_ACCESS_TOKEN ?? "",});const organization = await lexopti.organization.get();const buyer = await lexopti.clients.create({ type: "person", person: { first_name: "Camille", last_name: "Durand SANCTION", birth_date: "1980-02-01", nationalities: ["FR"], },});const seller = await lexopti.clients.create({ type: "person", person: { first_name: "Louis", last_name: "Martin", birth_date: "1975-06-15", nationalities: ["FR"], },});const sale = await lexopti.cases.create({ types: ["vente_immobiliere"], clients: [{ id: buyer.id }, { id: seller.id }], label: "Vente 12 rue des Lilas",});console.log(organization.sandbox, sale.id, sale.type);Lancez-le depuis le terminal où LEXOPTI_ACCESS_TOKEN est défini :
npx tsx quickstart.mtsEnregistrez ce script sous quickstart.php (PHP 8.1 ou plus récent, avec son extension curl) :
<?php declare(strict_types=1); /** One call to LexOpti's API, its JSON answer decoded (PHP 8.1+, ext-curl). */function lexopti(string $method, string $path, ?array $body = null): array{ $curl = curl_init((getenv('LEXOPTI_URL') ?: 'https://app.lexopti.com') . $path); $headers = ['Authorization: Bearer ' . getenv('LEXOPTI_ACCESS_TOKEN'), 'Accept: application/json']; if ($body !== null) { // A creation or a launch sends a key: its retry never repeats it. $headers[] = 'Idempotency-Key: ' . bin2hex(random_bytes(16)); $headers[] = 'Content-Type: application/json'; curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($body, JSON_THROW_ON_ERROR)); } curl_setopt_array($curl, [ CURLOPT_CUSTOMREQUEST => $method, CURLOPT_HTTPHEADER => $headers, CURLOPT_RETURNTRANSFER => true, ]); $answer = json_decode((string) curl_exec($curl), true); if (curl_getinfo($curl, CURLINFO_RESPONSE_CODE) >= 400 || !is_array($answer)) { throw new RuntimeException($answer['detail'] ?? 'LexOpti did not answer.'); } return $answer;} $organization = lexopti('GET', '/v1/organization');$buyer = lexopti('POST', '/v1/clients', [ 'type' => 'person', 'person' => [ 'first_name' => 'Camille', 'last_name' => 'Durand SANCTION', 'birth_date' => '1980-02-01', 'nationalities' => ['FR'], ],]);$seller = lexopti('POST', '/v1/clients', [ 'type' => 'person', 'person' => [ 'first_name' => 'Louis', 'last_name' => 'Martin', 'birth_date' => '1975-06-15', 'nationalities' => ['FR'], ],]);$sale = lexopti('POST', '/v1/cases', [ 'types' => ['vente_immobiliere'], 'clients' => [['id' => $buyer['id']], ['id' => $seller['id']]], 'label' => 'Vente 12 rue des Lilas',]);echo json_encode($organization['sandbox']), ' ', $sale['id'], ' ', $sale['type'], PHP_EOL;Lancez-le depuis le terminal où LEXOPTI_ACCESS_TOKEN est défini :
php quickstart.phpCréez l’acquéreur :
curl https://app.lexopti.com/v1/clients \ -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ --json '{ "type": "person", "person": { "first_name": "Camille", "last_name": "Durand SANCTION", "birth_date": "1980-02-01", "nationalities": ["FR"] } }'Gardez l’id qu’il répond, et créez le vendeur :
export BUYER=THE_BUYER_IDcurl https://app.lexopti.com/v1/clients \ -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ --json '{ "type": "person", "person": { "first_name": "Louis", "last_name": "Martin", "birth_date": "1975-06-15", "nationalities": ["FR"] } }'Gardez aussi son id, et créez le dossier de la vente pour les deux :
export SELLER=THE_SELLER_IDcurl https://app.lexopti.com/v1/cases \ -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" \ -H "Idempotency-Key: $(uuidgen)" \ --json "{ \"types\": [\"vente_immobiliere\"], \"clients\": [{\"id\": \"$BUYER\"}, {\"id\": \"$SELLER\"}], \"label\": \"Vente 12 rue des Lilas\" }"Le script affiche true (votre organisation est un bac à sable), l’identifiant du dossier et sa nature vente_immobiliere ; avec curl, la réponse est le dossier lui-même (201). Rien n’est encore analysé : son pending_alert_count est 0.
5. Lancer les analyses
Section intitulée « 5. Lancer les analyses »Un seul appel lance les analyses du dossier, comme le bouton « Lancer les analyses » de LexOpti sur la page du dossier : tous les clients et parties du dossier sont passés au crible des sources, et chaque client reçoit une analyse qui est la vôtre. (Pour créer un dossier et lancer ses analyses en un seul appel, envoyez launch_checks: true avec POST /v1/cases.)
Ajoutez ces lignes à la fin de quickstart.mts, puis relancez le script :
const launch = await lexopti.cases.launchChecks({ id: sale.id });console.log( launch.checks.length, launch.checks.map((check) => check.status).join(" "));Ajoutez ces lignes à la fin de quickstart.php, puis relancez le script :
$launch = lexopti('POST', '/v1/cases/' . $sale['id'] . '/checks', []);echo count($launch['checks']), ' ', implode(' ', array_column($launch['checks'], 'status')), PHP_EOL;Gardez l’id du dossier, puis lancez ses analyses :
export CASE=THE_CASE_IDcurl -X POST https://app.lexopti.com/v1/cases/$CASE/checks \ -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" \ -H "Idempotency-Key: $(uuidgen)"Un script relancé crée un second dossier, avec deux nouveaux clients du bac à sable. La nouvelle ligne donne le nombre d’analyses lancées, une par client du dossier, et le statut de chacune ; avec curl, la réponse est le dossier lui-même (202), avec ses checks. Une analyse est asynchrone : votre intégration la suit, ou attend check.completed.
6. Lire le résultat
Section intitulée « 6. Lire le résultat »Ajoutez ces lignes à la fin de quickstart.mts, puis relancez le script :
const checks = await Promise.all( launch.checks.map((check) => lexopti.checks.get({ id: check.id })));const settled = await lexopti.cases.get({ id: sale.id });const buyerAlerts = await lexopti.alerts.list({ client_id: buyer.id });const sellerAlerts = await lexopti.alerts.list({ client_id: seller.id });console.log( checks.map((check) => check.status).join(" "), settled.pending_alert_count, sellerAlerts.data.length);for (const alert of buyerAlerts.data) { console.log(alert.status, alert.source);}Ajoutez ces lignes à la fin de quickstart.php, puis relancez le script :
$statuses = [];foreach ($launch['checks'] as $check) { $statuses[] = lexopti('GET', '/v1/checks/' . $check['id'])['status'];}$settled = lexopti('GET', '/v1/cases/' . $sale['id']);$buyerAlerts = lexopti('GET', '/v1/alerts?' . http_build_query(['client_id' => $buyer['id']]));$sellerAlerts = lexopti('GET', '/v1/alerts?' . http_build_query(['client_id' => $seller['id']]));echo implode(' ', $statuses), ' ', $settled['pending_alert_count'], ' ', count($sellerAlerts['data']), PHP_EOL;foreach ($buyerAlerts['data'] as $alert) { echo $alert['status'], ' ', $alert['source'], PHP_EOL;}Gardez l’id de chaque analyse depuis les checks de la réponse (son client_id dit à qui elle est), puis lisez-les, avec le dossier et les alertes de chaque client :
export BUYER_CHECK=THE_BUYER_CHECK_IDexport SELLER_CHECK=THE_SELLER_CHECK_IDcurl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" https://app.lexopti.com/v1/checks/$BUYER_CHECKcurl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" https://app.lexopti.com/v1/checks/$SELLER_CHECKcurl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" https://app.lexopti.com/v1/cases/$CASEcurl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" "https://app.lexopti.com/v1/alerts?client_id=$BUYER"curl -H "Authorization: Bearer $LEXOPTI_ACCESS_TOKEN" "https://app.lexopti.com/v1/alerts?client_id=$SELLER"Cette fois, vous lisez les deux analyses completed, les trois alertes que le dossier compte pour l’examen d’un membre (pending_alert_count), et aucune pour le vendeur ; puis les alertes de l’acquéreur, pending, une par source de sanctions : international_sanctions, eu_sanctions et french_asset_freezes, dans un ordre quelconque. Un membre les examine dans LexOpti, sur le dossier.
Vous avez autorisé une application, ouvert un dossier avec ses clients par l’API, lancé ses analyses et lu ce qu’elles ont trouvé, comme un membre le verrait dans LexOpti.
- Construire une intégration complète : le rappel, le rafraîchissement des jetons, les webhooks et les composants embarqués dans votre propre logiciel, et un dossier créé depuis votre propre fiche, ses parties et son prix prévisualisé.
- Concepts : ce que sont un client, un dossier, une analyse et une alerte, et pourquoi un membre valide le niveau de risque.