> ## 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.

# Ruby SDK für KYC, AML und Transaktionen

> Schnellstart für das offizielle Didit Ruby SDK: Server-APIs über net/http aufrufen, Rails-kompatible Webhook-Prüfung und Authentifizierungs-Token prüfen.

Das offizielle Didit-Gem für Ruby. Es erfordert Ruby 3.1 oder neuer und verwendet `net/http` aus der Standardbibliothek. Unter [Übersicht über die Server-SDKs](https://docs.didit.me/de/integration/server-sdks/overview.md) erfahren Sie, was alle SDKs gemeinsam haben.

## Installation

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

Das Gem ist [`didit-sdk` auf RubyGems](https://rubygems.org/gems/didit-sdk). Der Quellcode und das Changelog befinden sich in [didit-protocol/sdk-ruby](https://github.com/didit-protocol/sdk-ruby) auf GitHub.

Oder fügen Sie Ihrem Gemfile `gem "didit-sdk"` hinzu und führen Sie `bundle install` aus. Laden Sie es mit `require "didit"`.

## Client konfigurieren

`Didit::Client.new` liest `DIDIT_API_KEY` aus den Umgebungsvariablen. Übergeben Sie Schlüsselwortargumente, um dies zu überschreiben oder um die Organisations- und Anwendungs-IDs festzulegen, die anwendungsbezogene Aufrufe (Fälle, Netzwerke, regulatorische Berichte) benötigen. Anfragefelder sind Schlüsselwortargumente mit den nativen Namen der API; Antworten sind Objekte mit einem Reader pro Feld, `[:field]` und `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
```

## Sitzung erstellen

Erstellen Sie eine [Verifizierungssitzung](https://docs.didit.me/de/sessions-api/create-session.md) für einen Workflow und leiten Sie Ihren Benutzer zu deren URL weiter.

```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
```

## Entscheidung abrufen

Sobald der Benutzer den Vorgang abschließt (oder wenn der Webhook eingeht), [rufen Sie die Entscheidung ab](https://docs.didit.me/de/sessions-api/retrieve-session.md). Jedes Funktionsergebnis ist eine Liste mit einem Eintrag pro Workflow-Knoten.

```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
```

## Webhook verifizieren

Übergeben Sie den Raw-Body genau so, wie er empfangen wurde, sowie die Anfrage-Header. `verify` löst bei allem, was keine gültige, aktuelle Zustellung ist, einen `Didit::WebhookVerificationError` aus und gibt andernfalls ein typisiertes Ereignis zurück.

```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
```

Rufen Sie in Rails `handle_webhook(request.raw_post, request.headers)` auf. Wenn Sie das Secret rotieren, übergeben Sie beide: `[new_secret, old_secret]`. Siehe [Webhooks](https://docs.didit.me/de/integration/webhooks.md) für die Ereignisse und das Signaturschema.

## Transaktion screenen

Übermitteln Sie eine Zahlung, eine Auszahlung oder einen Krypto-Transfer an die [Transaktionsüberwachung](https://docs.didit.me/de/transaction-monitoring/overview.md); die Antwort enthält ihren Status und Risiko-Score.

```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}"
```

## Authentication-Token verifizieren

`Didit::Authentication` überprüft die Zugriffstoken, die Ihr [Authentication](https://docs.didit.me/de/authentication/overview.md)-Issuer signiert, in Ihrem Backend, ohne Didit bei jeder Anfrage aufzurufen. Es tauscht außerdem Codes aus, aktualisiert Token, prüft und widerruft Sitzungen und führt Step-ups durch.

> [!NOTE]
>
> Die Token-Verifizierung führt die Prüfungen aus [Token auf Ihrem Server verifizieren](https://docs.didit.me/de/authentication/tokens-and-jwks.md#token-auf-ihrem-server-prüfen) anhand des Issuers und der Signaturschlüssel Ihrer Anwendung durch.

```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
```

## Fehler

```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
```

## Listen und Dateien

```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
```

Die Seiten zu den Server-Endpoints in der [API-Referenz](https://docs.didit.me/de/api-reference/overview.md) enthalten ein Ruby-Beispiel für ihre jeweilige Operation, mit Ausnahme der in der [Übersicht](https://docs.didit.me/de/integration/server-sdks/overview.md) genannten Endpoints und Felder, die im Release 1.0.1 noch nicht enthalten sind.


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