> ## 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 para KYC, AML e Transações

> Guia rápido do SDK Ruby oficial da Didit: chamadas às APIs do servidor com net/http, webhooks compatíveis com Rails e verificação de tokens de autenticação.

A gem oficial da Didit para Ruby. Requer Ruby 3.1 ou posterior e usa o `net/http` da biblioteca padrão. Consulte a [visão geral dos SDKs de servidor](https://docs.didit.me/pt/integration/server-sdks/overview.md) para saber o que todos os SDKs têm em comum.

## Instalação

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

A gem é [`didit-sdk` no RubyGems](https://rubygems.org/gems/didit-sdk). O código-fonte e o registo de alterações estão em [didit-protocol/sdk-ruby](https://github.com/didit-protocol/sdk-ruby) no GitHub.

Ou adicione `gem "didit-sdk"` ao seu Gemfile e execute `bundle install`. Carregue-a com `require "didit"`.

## Configurar o cliente

`Didit::Client.new` lê `DIDIT_API_KEY` a partir do ambiente. Passe argumentos nomeados para a substituir, ou para definir os IDs da organização e da aplicação de que precisam as chamadas com âmbito de aplicação (casos, redes, relatórios regulamentares). Os campos do pedido são argumentos nomeados com os nomes da própria API; as respostas são objetos com um acessor para cada campo e podem ser acedidas através de `[:field]` e `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
```

## Criar uma sessão

Crie uma [sessão de verificação](https://docs.didit.me/pt/sessions-api/create-session.md) para um fluxo e envie o seu utilizador para o respetivo 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
```

## Ler a decisão

Quando o utilizador concluir (ou quando o webhook chegar), [leia a decisão](https://docs.didit.me/pt/sessions-api/retrieve-session.md). Cada resultado de funcionalidade é uma lista com uma entrada por nó do fluxo.

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

## Verificar um webhook

Passe o corpo bruto, exatamente como recebido, e os cabeçalhos do pedido. `verify` lança `Didit::WebhookVerificationError` para qualquer entrega que não seja válida e recente, e devolve um evento tipado caso contrário.

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

No Rails, chame `handle_webhook(request.raw_post, request.headers)`. Durante a rotação do segredo, passe os dois: `[new_secret, old_secret]`. Consulte [Webhooks](https://docs.didit.me/pt/integration/webhooks.md) para ver os eventos e o esquema de assinatura.

## Fazer triagem de uma transação

Envie um pagamento, um levantamento ou uma transferência de cripto-ativos para a [monitorização de transações](https://docs.didit.me/pt/transaction-monitoring/overview.md); a resposta inclui o respetivo estado e a pontuação de risco.

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

## Verificar tokens do Authentication

`Didit::Authentication` verifica, no seu backend, os tokens de acesso assinados pelo emissor da sua [Authentication](https://docs.didit.me/pt/authentication/overview.md), sem chamar a Didit em cada pedido. Também troca códigos, atualiza tokens, verifica e revoga sessões, e executa autenticações adicionais.

> [!NOTE]
>
> A verificação de tokens faz as validações indicadas em [Verificar um token no seu servidor](https://docs.didit.me/pt/authentication/tokens-and-jwks.md#verifique-um-token-no-seu-servidor), com base no emissor e nas chaves de assinatura da sua aplicação.

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

## Erros

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

## Listas e ficheiros

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

As páginas de endpoints de servidor da [referência da API](https://docs.didit.me/pt/api-reference/overview.md) têm um exemplo em Ruby para a respetiva operação, exceto nos endpoints e campos que ainda não foram incluídos numa versão 1.0.1, indicados na [visão geral](https://docs.didit.me/pt/integration/server-sdks/overview.md).


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