RSA

ws-hop-api-rsa

Import RSA / ECC Key Module

post

Imports an RSA or ECC Public Key by generating a MAC on it.

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 99

publicKeyEncodinginteger · enumRequired

Regras de codificação da chave pública:

1: DER encoded ASN.1 RSA Public Key (INTEGER com representação unsigned)
2: DER encoded ASN.1 RSA Public Key (INTEGER com representação 2's complement)
3: DER encoded ASN.1 ECC X9.62 format uncompressed key

Example: 2Possible values:

publicKeystringRequired

Chave pública RSA ou ECC em formato DER encoded ASN.1 em Hex. Para RSA: SubjectPublicKeyInfo ou RSAPublicKey. Para ECC: X9.62 uncompressed point format.

Example: 3082020A0282020100...

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestringOptional

Valor de retorno — chave exportada/importada em Hex

Example: 41DDE024A43282C2...

retDescriptionstringOptional

Descrição do resultado

Example: OK

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

500

Erro interno do servidor

application/json

post/v4/PayShieldRsa/Import

POST /v4/PayShieldRsa/Import HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1105

{
  "client_id": 99,
  "publicKeyEncoding": 2,
  "publicKey": "3082020A0282020100A069D9C3C28077EED1D5DD0126D9CE4E46D28E6F9C23A54DD65EF65904814873256E529F0739C9E312EDD0D2F78D4F68EA8DCFADDC69A73F6E166D952DCD4585F0F77E402398ECD690D2FD29E136FC457139727D5D3DF120A67906D66AEE9F310ADA9ADA34CF1D882AE5CE07052CC8D9C6501A527470A6DCC6F6FA1F3F422D06ED10DFDC60CD761234567890123457057D54938F0F21F50E09C11F4600C3A33023F333EDEE41660F61708A72D98A3840CD3CAD477D4CA75D9AEC4EA48CF609D3DDC2D0747F2A6647D65DF364CDA80603DD6D097520DC06F34467D08713A5DD68F76550CC7F77CF3DCFD45439D3D7DE1956DD3825E7A25FAC8FD2603D8AA05085F4A7F141FF61C57C1D4ECDE3DF15C6AD6E09538D105DAF051DC1D3F5523344D74824A4D3C8F36069AE1A927566FFA519D8D37616969DEDC48067E9E66E858199906D26645F784DFC3EE27EFF66E18505DC56234DEE0D1E5840DD3D85E5F36E75DFDA135229F8FA40E3D24497679DEDE221D0D0A3DAD2561A50C86D68D21F9FA9DAC8E327597E9900D3045D73F780E7E3578306C65192C0CDDDF90199A1CDE6D859A753D8DA638DEE502A2D7DECF403F273F63F628EE84C71EF5F80D8C795690EA55AF1A20164D900C6E7F835E70626CCDA5C3D969A776E9371DFC0A9541AF7F814770E922DDA9D8ECE4853FDF4D2D814CDF56FD7362D83C7FCF1FAE866298E6D0203010001"
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "S1056002RN00S00013082020A0282020100A069D9C3C28077EED1D5DD0126D12345678901234523A54DD65EF65904814873256E529F0739C9E312EDD0D2F1FA4F68EA8DCFADDC69A73F6E166D952DCD4585F0F77E402398ECD690D2FD29E136FC457139727D5D3DF120A67906D66AEE9F310ADA9ADA34CF1D882AE5CE07052CC8D9C6501A527470A6DCC6F6FA1F3F422D06ED10DFDC60CD76A2ECE6E32E73CEE7057D54938F0F21F50E09C11F4600C3A33023F333EDEE41660F61708A72D98A3840CD3CAD477D4CA75D9AEC4EA48CF609D3DDC2D0747F2A6647D65DF364CDA80603DD6D097520DC06F34467D08713A5DD68F76550CC7F77CF3DCFD45439D3D7DE1956DD3825E7A25FAC8FD2603D8AA05085F4A7F141FF61C57C1D4ECDE3DF15C6AD6E09538D105DAF051DC1D3F5523344D74824A4D3C8F36069AE1A927566FFA519D8D37616969DEDC48067E9E66E858199906D26645F784DFC3EE27EFF66E18505DC56234DEE0D1E5840DD3D85E5F36E75DFDA135229F8FA40E3D24497679DEDE221D0D0A3DAD2561A50C86D68D21F9FA9DAC8E327597E9900D3045D73F780E7E3578306C65192C0CDDDF90199A1CDE6D859A753D8DA638DEE502A2D7DECF403F273F63F628EE84C71EF5F80D8C795690EA55AF1A20164D900C6E7F835E70626CCDA5C3D969A776E9371DFC0A9541AF7F814770E922DDA9D8ECE4853FDF4D2D814CDF56FD7362D83C7FCFD37E866298E6D0203010001DA6F3AA02D60C45DF961",
  "retDescription": "OK"
}

Export Key under an RSA Public Key Module

post

Translate a DES, AES or HMAC key from encryption under an LMK pair to encryption under a public key.

Authorizations

AuthorizationstringRequired

Token JWT obtido via Auth0

Body

client_idinteger · int64 · min: 1Required

Identificador do cliente

Example: 42

keyIdstringRequired

Alias/identificador da chave a ser exportada no banco de dados

Example: client-42-key-id-764-ECCPK

padModeIdinteger · enumRequired

Identificador do modo de padding usado na criptografia:

1: PKCS#1 v1.5 (EME-PKCS1-v1_5)
2: PKCS#1 v2.2 OAEP (EME-OAEP-ENCODE) — requer mgfHashFunction

Example: 2Possible values:

mgfHashFunctioninteger · enum · nullableOptional

Identificador da função hash MGF — obrigatório apenas quando padModeId: 2 (OAEP):

1: SHA-1
5: SHA-224
6: SHA-256
7: SHA-384
8: SHA-512

Example: 6Possible values:

publicKeystringRequired

Chave pública RSA em formato Key Block Thales (Hex). Gerada pelo endpoint Import deste mesmo serviço.

Example: 3082020A0282020100...

keyBlockTypeinteger · enumRequired

Tipo do Key Data Block:

3: Unformatted Key Data Block (único valor suportado atualmente)

Example: 3Possible values:

Responses

200

Operação realizada com sucesso

application/json

retCodeintegerOptional

Código de retorno. 0 = sucesso, outros valores indicam erro

Example: 0

retValidbooleanOptional

Indica se a operação foi bem-sucedida

Example: true

retValuestringOptional

Valor de retorno — chave exportada/importada em Hex

Example: 41DDE024A43282C2...

retDescriptionstringOptional

Descrição do resultado

Example: OK

400

Requisição inválida

application/json

401

Não autorizado — token Bearer ausente ou inválido

404

Chave não encontrada no banco de dados

application/json

500

Erro interno do servidor

application/json

post/v4/PayShieldRsa/Export

POST /v4/PayShieldRsa/Export HTTP/1.1
Host: api-hext.first-tech.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1173

{
  "client_id": 99,
  "keyId": "client-99-key-id-XXXXX-ECCPK",
  "padModeId": 2,
  "mgfHashFunction": 6,
  "publicKey": "3082020A0282020100A069D9C3C28077EEB1B5DB0126B9CE4E46B28E6F9C23A54BB65EF65904814873256E529F0739C9E312EBD0B2F78D4F68EA8DCFADDC69A73F6E166D952BCD4585F0F77E402398ECD690B2FD29E136FC457139727D5B3DF120A6123456789012345ADA9ABA34CF1D882AE5CE07052CC8D9C6501A527470A6DCC6F6FA1F3F422D06EB10DFDC60CD76A2ECE6E32E73CEE7057B54938F0F21F50E09C11F4600C3A33023F333EDEE41660F61708A72B98A3840CD3CAD477D4CA75D9AEC4EA48CF609D3BDC2D0747F2A6647B65BF364CBA80603DD6B097520BC06F34467B08713A5BD68F76550CC7F77CF3BCFB45439B3B7BE1956BB3825E7A25FAC8FD2603B8AA05085F4A7F141FF61C57C1D4ECBE3BF15C6AD6E09538B105DAF051BC1D3F5523344B74824A4D3C8F36069AE1A927566FFA519B8B37616969DEDC48067E9E66E858199906B26645F784DFC3EE27EFF66E18505DC56234DEE0B1E5840DB3B85E5F36E75DFBA135229F8FA40E3B24497679DEDE221D0D0A3BAB2561A50C86D68B21F9FA9DAC8E327597E9900D3045D73F780E7E3578306C65192C0CDBDF90199A1CBE6B859A753B8BA638BEE502A2D7BECF403F273F63F628EE84C71EF5F80B8C795690EA55AF1A20164D900C6E7F835E70626CCDA5C3B969A776E9371BFC0A9541AF7F814770E922BBA9B8ECE4853FBF4D2B814CBF56FD7362D83C7FCFD37E866298E6B0203010001",
  "keyBlockType": 3
}

{
  "retCode": 0,
  "retValid": true,
  "retValue": "41DDE024A43282C25C897889E87DE2937C87B31913FD7DC4CF1C167F33D0D98E4F86D6D3032A7D6573799BF177ACB6095E24CD1D4DE35C53D5479E93B39CDCAC375586BAF20347D611CA0DC3E3DEF6B8D87234BB4486878E573134F68ACBB641E08E2080CF2401234567890123457ED47A8085996DAC27CF96E9C9FECC615317592FF0F98C25CE7E6A3664AEE5721DF7A8F8253EA5FFAA2E462A564F21A8651D49971008FB54FD4A4E4C4DF88AE5E0CB79F2484034DEE3B8D9817D4F26D3CC6BFF0D05331B359FA6964224C1D4C87CDEA3C6D35E16A22D143F667253BAB3B2B66E8DE44ED415A777346EA202C8E2600E1E8C4C4BDC2B2160D3B03AC26555BF06F81109603AE7EEC45B838ED9D2172A57AB19FEA15CC5CF341A9D7EF8B01D96258691D0D4B6F0FF025393828C77E6F9E96BC5E8BF9A6B8626CB722D5EE53FF221100D7F817F71325FEE9A3D3B3469B7C3B0B9ABC276B0C54A9404DB73822C5A3821191142ED18791F761408753B48DB8558A0B5897807211015686564EA1E77F34A4AD65FA5929EF5A7AA174CC6B63270E064E6C1299913458F6B6E26922FF9CCE7F1CF7CB59D6E0D2834F2182C7AB7C8CB2F0B798270AA8B220C211E21AEB9017136D404C4CAE9D28923088391161A8762104B007FDDA301D3F6C98A084E30843641D62E8B282477E1E38D55052C3868AF18B257B13DF2158315A981C1E3A2F2",
  "retDescription": "OK"
}

PreviousKey Manager

Last updated 2 months ago