> ## Documentation Index
> Fetch the complete documentation index at: https://docs.didit.me/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK Ruby pour KYC, AML et transactions

> Guide de démarrage du SDK Ruby officiel de Didit : appels API serveur (net/http), webhooks pour Rails et tokens d'authentification.

La gem officielle de Didit pour Ruby. Elle nécessite Ruby 3.1 ou une version ultérieure et utilise `net/http` de la bibliothèque standard. Consultez la [vue d'ensemble des SDK serveur](https://docs.didit.me/fr/integration/server-sdks/overview.md) pour connaître les éléments communs à tous les SDK.

## Installation

```bash theme={null}
gem install didit-sdk
```

La gem est [`didit-sdk` sur RubyGems](https://rubygems.org/gems/didit-sdk). Son code source et son journal des modifications sont disponibles dans [didit-protocol/sdk-ruby](https://github.com/didit-protocol/sdk-ruby) sur GitHub.

Vous pouvez aussi ajouter `gem "didit-sdk"` à votre Gemfile et exécuter `bundle install`. Chargez-la avec `require "didit"`.

## Configurer le client

`Didit::Client.new` lit `DIDIT_API_KEY` depuis l'environnement. Passez des arguments nommés pour le remplacer, ou pour définir les identifiants d'organisation et d'application dont ont besoin les appels à portée d'application (dossiers, réseaux, rapports réglementaires). Les champs de requête sont des arguments nommés portant les noms propres à l'API ; les réponses sont des objets dotés d'un accesseur par champ, `[:field]` et `to_h`.

```ruby theme={null}
require "didit"

didit = Didit::Client.new(
  api_key: ENV["DIDIT_API_KEY"],
  organization_id: ENV["DIDIT_ORGANIZATION_ID"],
  application_id: ENV["DIDIT_APPLICATION_ID"],
  timeout: 30,
  max_retries: 2
)

# Options for a single call.
decision = didit.with_options(timeout: 5, max_retries: 0).sessions.retrieve_decision("11111111-2222-3333-4444-555555555555")
puts decision.status
```

## Créer une session

Créez une [session de vérification](https://docs.didit.me/fr/sessions-api/create-session.md) pour un workflow et redirigez votre utilisateur vers son URL.

```ruby theme={null}
require "didit"

didit = Didit::Client.new

session = didit.sessions.create(
  workflow_id: "11111111-2222-3333-4444-555555555555",
  vendor_data: "user-123",
  callback: "https://example.com/verification/done"
)
puts session.url
```

## Lire la décision

Lorsque l'utilisateur a terminé (ou dès que le webhook arrive), [lisez la décision](https://docs.didit.me/fr/sessions-api/retrieve-session.md). Chaque résultat de fonctionnalité est une liste contenant une entrée par nœud du workflow.

```ruby theme={null}
require "didit"

didit = Didit::Client.new

decision = didit.sessions.retrieve_decision("11111111-2222-3333-4444-555555555555")
puts decision.status
(decision.id_verifications || []).each do |verification|
  puts verification.status
end
```

## Vérifier un webhook

Transmettez le corps brut, tel que reçu, et les en-têtes de la requête. `verify` lève `Didit::WebhookVerificationError` pour toute livraison qui n'est pas à la fois valide et récente, et renvoie un événement webhook typé dans le cas contraire.

```ruby theme={null}
require "didit"

WEBHOOK_SECRET = ENV.fetch("DIDIT_WEBHOOK_SECRET", "")

def handle_webhook(raw_body, headers)
  event = Didit::Webhooks.verify(raw_body, headers, WEBHOOK_SECRET)
  case event
  when Didit::Webhooks::StatusUpdatedEvent
    puts "#{event.session_id} #{event.status}"
  end
  200
rescue Didit::WebhookVerificationError => e
  puts "rejected: #{e.reason}"
  400
end
```

Dans Rails, appelez `handle_webhook(request.raw_post, request.headers)`. Pendant la rotation du secret, transmettez les deux : `[new_secret, old_secret]`. Consultez [Webhooks](https://docs.didit.me/fr/integration/webhooks.md) pour les événements et le schéma de signature.

## Filtrer une transaction

Soumettez un paiement, un retrait ou un transfert de crypto-actifs à la [surveillance des transactions](https://docs.didit.me/fr/transaction-monitoring/overview.md) ; la réponse contient son statut et son score de risque.

```ruby theme={null}
require "didit"

didit = Didit::Client.new

transaction = didit.transactions.create(
  transaction_id: "txn-1001",
  transaction_category: "finance",
  transaction_details: { direction: "outbound", amount: 1500, currency: "EUR" },
  subject: { entity_type: "individual", vendor_data: "user-123", full_name: "Maria Garcia" }
)
puts "#{transaction.status} #{transaction.score}"
```

## Vérifier les tokens Authentication

`Didit::Authentication` vérifie, côté backend et sans appeler Didit à chaque requête, les tokens d'accès signés par votre émetteur [Authentication](https://docs.didit.me/fr/authentication/overview.md). Elle permet aussi d'échanger des codes, de rafraîchir les tokens, de vérifier et révoquer des sessions, et de lancer des étapes de renforcement.

> [!NOTE]
>
> La vérification des tokens effectue les contrôles décrits dans [Vérifier un token sur votre serveur](https://docs.didit.me/fr/authentication/tokens-and-jwks.md#vérifier-un-jeton-sur-votre-serveur), avec l'émetteur et les clés de signature de votre application.

```ruby theme={null}
require "didit"

# Your issuer URL, or Didit::Authentication.from_publishable_key("pk_live_...", client_id: ...).
AUTH = Didit::Authentication.new("https://your-app.auth.didit.me", client_id: "your-application-id")

def current_user(access_token)
  AUTH.verify_access_token(access_token).sub
rescue Didit::TokenVerificationError => e
  puts "rejected: #{e.reason}"
  nil
end
```

## Erreurs

```ruby theme={null}
require "didit"

didit = Didit::Client.new

begin
  didit.sessions.retrieve_decision("11111111-2222-3333-4444-555555555555")
rescue Didit::NotFoundError
  puts "no such session"
rescue Didit::APIStatusError => e
  puts "#{e.status} #{e.request_id}"
end
```

## Listes et fichiers

```ruby theme={null}
require "didit"

didit = Didit::Client.new

# Lists page through every result.
didit.sessions.list(status: "Approved").auto_paging_each do |session|
  puts session.session_id
end

# Uploads take a Pathname, an IO or Didit::FilePart. A String is sent as the file's bytes.
result = didit.id_verification.verify(
  front_image: Pathname("id-front.jpg"),
  back_image: Pathname("id-back.jpg")
)
puts result.to_h
```

Les pages d'endpoints serveur de la [référence API](https://docs.didit.me/fr/api-reference/overview.md) comportent un exemple Ruby pour leur opération, à l'exception des endpoints et des champs qu'aucune version 1.0.1 ne propose encore, mentionnés dans la [vue d'ensemble](https://docs.didit.me/fr/integration/server-sdks/overview.md).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.