Guia completo para integrar as APIs da ROOTKey

Saiba como integrar as APIs da ROOTKey para armazenar, verificar e gerir documentos na blockchain de forma segura, com um guia passo a passo e exemplos de código.

10 min de leituraProdutos · Programadores
Imagem de capa

À medida que a segurança digital se torna uma preocupação crescente em todos os setores, integrar soluções de cibersegurança robustas nunca foi tão crítico. A missão da ROOTKey é garantir a validade, a integridade e a autenticidade dos dados ao longo de todo o seu ciclo de vida. As nossas APIs oferecem aos programadores formas fluidas de integrar segurança baseada em blockchain nas suas aplicações, permitindo autenticação descentralizada, validação de dados e a manutenção de registos imutáveis.

Neste guia, vamos explorar:

  • De que forma as APIs da ROOTKey apoiam a transformação digital.
  • Os passos práticos para integrar as APIs da ROOTKey, desde a obtenção das chaves de API até à proteção de documentos.
  • Os benefícios técnicos de utilizar o nosso conjunto de APIs.

No final deste artigo, terá uma compreensão abrangente de como integrar as APIs da ROOTKey no seu sistema de forma eficiente.

1. Como as APIs da ROOTKey apoiam a transformação digital

As APIs (interfaces de programação de aplicações) funcionam como a ponte entre diferentes sistemas digitais, permitindo uma comunicação e uma interoperabilidade fluidas. No panorama digital acelerado de hoje, as empresas dependem cada vez mais de APIs para reforçar a segurança, automatizar processos e garantir a integridade dos dados.

Na ROOTKey, entendemos que a segurança não deve ficar para depois, mas ser uma componente central da transformação digital. Eis como as nossas APIs se alinham com a nossa missão:

  • Garantir a validade e a autenticidade dos dados: as nossas APIs disponibilizam mecanismos de validação criptográfica que permitem a empresas e programadores verificar a autenticidade de ativos digitais em tempo real.
  • Eliminar dependências de confiança: ao tirar partido da blockchain, a ROOTKey viabiliza soluções de segurança descentralizadas em que a confiança assenta em protocolos criptográficos e não em terceiros.
  • Reforçar a conformidade e o cumprimento regulamentar: perante um escrutínio regulamentar crescente, as organizações têm de garantir a auditabilidade e a conformidade. O nosso conjunto de APIs facilita a manutenção de registos imutáveis, tornando a conformidade um processo sem atritos.
  • Segurança fluida e escalável: as nossas APIs foram concebidas para uma integração fácil, não só com aplicações de nível empresarial, mas também para programadores individuais que pretendam reforçar a segurança dos seus projetos pessoais ou de startups. Assim, tanto as grandes organizações como os programadores independentes podem escalar as suas medidas de segurança à medida que os seus dados crescem.

Ao adotar o conjunto de APIs da ROOTKey, empresas e programadores podem proteger os seus dados, automatizar a gestão de ativos e implementar protocolos de segurança avançados sem perturbar os fluxos de trabalho existentes.

2. Guia prático para integrar as APIs da ROOTKey

Passemos agora aos detalhes técnicos da integração das APIs da ROOTKey. Segue-se um guia passo a passo:

Passo 1: obtenha a sua chave de API

Para começar a utilizar as APIs da ROOTKey, precisa de uma chave de API. Siga estes passos:

  1. Registe-se na plataforma da ROOTKey.
  2. Aceda à secção de gestão de chaves de API nas suas definições de programador.
  3. Gere uma nova chave de API.
  4. Proteja a sua chave de API - nunca a exponha publicamente (por exemplo, em código de front-end ou em repositórios).
Separador de API para programadores
Separador de API para programadores

Passo 2: crie o seu primeiro cofre

Antes de poder proteger um documento, precisa de um cofre para armazenar os seus dados em segurança. Este cofre funciona como o endereço do seu cofre proprietário, necessário para futuras operações de proteção de documentos.

Criar um cofre

O seguinte script em Python mostra como criar um cofre através da API da ROOTKey:

python
import requests
import json

API_KEY = "your_api_key_here"
API_URL = "https://rootkey.westeurope.cloudapp.azure.com/auth-service/api-v1/creation/wallet"

headers = {
    "Content-Type": "application/json",
    "x-api-key": API_KEY
}

data = {
    "walletName": "MyFirstVault",
    "description": "This is my first vault created with ROOTKey API"
}

response = requests.post(API_URL, headers=headers, data=json.dumps(data))

if response.status_code == 200:
    wallet_info = response.json()
    print("Vault created successfully:", wallet_info)
else:
    print("Vault creation failed:", response.json())
Detalhes da implementação

Se o pedido for bem-sucedido, a API devolve uma resposta como esta:

json
{
  "name": "MyFirstVault",
  "description": "This is my first vault created with ROOTKey API",
  "walletAddress": "0x123456789abcdef"
}
Resposta bem-sucedida

Tome nota do endereço do cofre, pois será utilizado no passo seguinte.

Passo 3: proteja o seu primeiro documento

Depois de criado o cofre, já pode proteger um documento através da API da ROOTKey. Este processo cria um documento na blockchain, garantindo a integridade, a validade e a autenticidade do documento.

Proteger um documento

O seguinte script em Python demonstra como carregar e proteger um documento:

import requests

API_KEY = "your_api_key_here"
API_URL = "https://rootkey.westeurope.cloudapp.azure.com/auth-service/api-v1/creation/smart-contract"

headers = {
    "x-api-key": API_KEY
}

data = {
    "ownerWallet": "0x123456789abcdef",  # Replace with your actual vault address
    "type": "rootkey",
    "subType": "sec1",
    "expirationDate": "2025-12-31"  # Optional expiration date
}

files = {
    "file": open("your_document.pdf", "rb")  # Replace with the actual file path
}

try:
    response = requests.post(API_URL, headers=headers, data=data, files=files)
    response_data = response.json()

    if response.status_code == 200:
        print("Document secured successfully:", response_data)
    else:
        print("Failed to secure document:", response_data)

except requests.exceptions.RequestException as e:
    print("API request error:", e)
Criação do ficheiro

O que está a acontecer aqui?

  • O documento é registado e associado ao seu cofre (ownerWallet).
  • Fica registado de forma permanente na blockchain da ROOTKey, o que garante que não pode ser alterado.
  • Se a operação for bem-sucedida, o documento fica protegido e verificável sempre que necessário.

O que acontece a seguir?

  1. Documento imutável - Armazenado na blockchain, o que garante a integridade e impede adulterações.
  2. Propriedade atribuída - Associado ao seu cofre para referência futura.
  3. Pronto para verificação - Confirme a autenticidade a qualquer momento através do endpoint de validação.
  4. Data de expiração definida - Se tiver indicado uma data de expiração, o documento permanece válido até essa data.
  5. Gestão de documentos - Obtenha, liste e faça a gestão dos documentos protegidos através da API.

O seu documento está agora protegido, auditável e verificável ao longo de todo o seu ciclo de vida. Muito bem!

3. Benefícios técnicos de utilizar as APIs da ROOTKey

As APIs da ROOTKey oferecem segurança de nível blockchain, integração fluida e elevada escalabilidade, o que as torna ideais tanto para empresas como para programadores individuais. Eis porque é que os programadores confiam nos nossos serviços:

  1. Integridade imutável dos dados
  • Cada transação é registada na blockchain, garantindo um armazenamento de dados permanente e à prova de adulteração.
  • Essencial para setores que exigem pistas de auditoria e conformidade (finanças, saúde, área jurídica).
  1. Infraestrutura escalável e de alto desempenho
  • Concebida para operações de baixa latência e elevado débito, suportando tanto implementações empresariais de grande escala como projetos de programadores de menor dimensão.
  • Alojada numa arquitetura cloud distribuída e redundante, garantindo fiabilidade e disponibilidade.
  1. Integração fluida com stacks tecnológicas modernas
  • O design RESTful da API permite uma integração simples com Python, Node.js, Java e muito mais.
  • Totalmente compatível com AWS, Azure, Google Cloud e outras plataformas cloud, para uma implementação simples.

Com a API da ROOTKey, obtém segurança de nível empresarial, escalabilidade flexível e uma integração sem esforço, tudo assente em tecnologia blockchain.

Conclusão

As APIs da ROOTKey dão aos programadores as ferramentas necessárias para integrar soluções de segurança digital seguras, escaláveis e eficientes. Quer pretenda validar dados, proteger registos digitais ou implementar segurança baseada em blockchain, as APIs da ROOTKey garantem que os seus dados permanecem válidos, autênticos e à prova de adulteração.

Um dos maiores pontos fortes da nossa oferta de APIs é a sua acessibilidade, tanto para empresas como para programadores individuais. Seja uma entidade empresarial a integrar segurança em grande escala ou um programador independente a criar uma aplicação de nova geração, a ROOTKey disponibiliza-lhe soluções de segurança de ponta, concebidas para uma implementação fluida e uma fiabilidade a longo prazo.

Se estiver pronto para começar, explore a nossa documentação da API em docs.rootkey.ai e dê o primeiro passo rumo a uma integração fluida da segurança digital. Para mais apoio, não hesite em contactar support@rootkey.ai.

Partilhar LinkedIn X
Todos os artigos

Fique a par

Receba insights de
ciber-resiliência no seu email.

Orientação prática e pronta para auditoria sobre integridade de dados, conformidade e continuidade - à medida que publicamos.