> ## 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 de Ruby de Didit per a KYC, AML i transaccions

> Inici ràpid del SDK oficial de Didit per a Ruby: crides a les API amb net/http, verificació de webhooks per a Rails i comprovació de tokens.

El gem oficial de Didit per a Ruby. Requereix Ruby 3.1 o posterior i utilitza `net/http` de la biblioteca estàndard. Consulta la [visió general dels SDK de servidor](https://docs.didit.me/ca/integration/server-sdks/overview.md) per veure què comparteix cada SDK.

## Instal·lació

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

El gem és [`didit-sdk` a RubyGems](https://rubygems.org/gems/didit-sdk). El codi font i el registre de canvis es troben a [didit-protocol/sdk-ruby](https://github.com/didit-protocol/sdk-ruby) a GitHub.

També pots afegir `gem "didit-sdk"` al teu Gemfile i executar `bundle install`. Carrega'l amb `require "didit"`.

## Configura el client

`Didit::Client.new` llegeix `DIDIT_API_KEY` de l'entorn. Passa arguments amb paraula clau per substituir-la, o per definir els identificadors d'organització i d'aplicació que necessiten les crides amb abast d'aplicació (casos, xarxes, informes regulatoris). Els camps de les sol·licituds són arguments amb paraula clau amb els noms propis de l'API; les respostes són objectes amb un lector per camp, `[:field]` i `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
```

## Crea una sessió

Crea una [sessió de verificació](https://docs.didit.me/ca/sessions-api/create-session.md) per a un flux de treball i envia el teu usuari a la seva 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
```

## Llegeix la decisió

Quan l'usuari acabi (o quan arribi el webhook), [llegeix la decisió](https://docs.didit.me/ca/sessions-api/retrieve-session.md). Cada resultat de funcionalitat és una llista amb una entrada per cada node del flux de treball.

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

## Verifica un webhook

Passa el cos brut, exactament tal com s'ha rebut, i les capçaleres de la sol·licitud. `verify` llança `Didit::WebhookVerificationError` per a qualsevol lliurament que no sigui vàlid i recent, i en cas contrari retorna un esdeveniment tipat.

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

A Rails, crida `handle_webhook(request.raw_post, request.headers)`. Mentre rotes el secret, passa'n tots dos: `[new_secret, old_secret]`. Consulta [Webhooks](https://docs.didit.me/ca/integration/webhooks.md) per veure els esdeveniments i l'esquema de signatura.

## Cribra una transacció

Envia un pagament, una retirada o una transferència de criptoactius al [monitoratge de transaccions](https://docs.didit.me/ca/transaction-monitoring/overview.md); la resposta inclou l'estat i la puntuació de risc.

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

## Verifica els tokens d'Authentication

`Didit::Authentication` comprova els tokens d'accés que signa el teu emissor d'[Authentication](https://docs.didit.me/ca/authentication/overview.md), al teu backend, sense cridar Didit a cada sol·licitud. També intercanvia codis, renova tokens, comprova i revoca sessions, i executa verificacions reforçades.

> [!NOTE]
>
> La verificació de tokens realitza les comprovacions descrites a [Verifica un token al teu servidor](https://docs.didit.me/ca/authentication/tokens-and-jwks.md#verifica-un-token-al-teu-servidor), contra l'emissor i les claus de signatura de la teva aplicació.

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

## Errors

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

## Llistes i fitxers

```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 pàgines d'endpoints de servidor de la [referència de l'API](https://docs.didit.me/ca/api-reference/overview.md) tenen un exemple en Ruby per a la seva operació, excepte els endpoints i els camps que cap versió 1.0.1 encara no té, que s'indiquen a la [visió general](https://docs.didit.me/ca/integration/server-sdks/overview.md).


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