summaryrefslogtreecommitdiff
path: root/libeufin
diff options
context:
space:
mode:
authorMarcello Stanisci <stanisci.m@gmail.com>2020-01-29 16:44:46 +0100
committerMarcello Stanisci <stanisci.m@gmail.com>2020-01-29 16:45:00 +0100
commit53e8d40909a7b6d4f3e0b889fbf77408b5d61c2e (patch)
treee5162bb77448f5b8aeb44a11a2b79f67aa7319d8 /libeufin
parentee0c59640938b9aa8b5d5f8fa598db2e7eaf6b1d (diff)
downloaddocs-53e8d40909a7b6d4f3e0b889fbf77408b5d61c2e.tar.gz
docs-53e8d40909a7b6d4f3e0b889fbf77408b5d61c2e.tar.bz2
docs-53e8d40909a7b6d4f3e0b889fbf77408b5d61c2e.zip
types
Diffstat (limited to 'libeufin')
-rw-r--r--libeufin/api-nexus.rst35
1 files changed, 17 insertions, 18 deletions
diff --git a/libeufin/api-nexus.rst b/libeufin/api-nexus.rst
index f0125796..fb02858c 100644
--- a/libeufin/api-nexus.rst
+++ b/libeufin/api-nexus.rst
@@ -64,44 +64,46 @@ Low-level EBICS API
.. ts:def:: NexusEbicsBackupRequest
interface NexusEbicsBackupRequest {
-
passphrase: string;
-
}
.. ts:def:: NexusEbicsBackupResponse
-
interface NexusEbicsBackupResponse {
// The three passphrase-protected private keys in the PKCS#8 format
- authBlob: binary;
- encBlob: binary;
- sigBlob: binary;
+ authBlob: string; // base64
+ encBlob: string; // base64
+ sigBlob: string; // base64
+ hostID: string;
+ userID: string;
+ partnerID: string;
+ ebicsURL: string;
}
.. http:post:: <nexus>/ebics/subscribers/{id}/restoreBackup
- Ask the server to restore the keys.
+ Ask the server to restore the keys. Always creates a NEW
+ "{id}" account, and fails if it exists already.
.. ts:def:: NexusEbicsRestoreBackupRequest
-
interface NexusEbicsRestoreBackupRequest {
// passphrase to decrypt the keys
passphrase: string;
// The three passphrase-protected private keys in the PKCS#8 format
- authBlob: binary;
- encBlob: binary;
- sigBlob: binary;
+ authBlob: string; // base64
+ encBlob: string; // base64
+ sigBlob: string; // base64
+ hostID: string;
+ userID: string;
+ partnerID: string;
+ ebicsURL: string;
}
-
-
-
.. ts:def:: NexusEbicsCreateSubscriber
.. http:post:: <nexus>/ebics/subscribers
@@ -129,17 +131,14 @@ Low-level EBICS API
Get details about an EBICS subscriber.
-
.. http:get:: <nexus>/ebics/subscriber/{id}/keyletter
- Get a nicely formatted key letter. (Does not return JSON, but markdown-formatted text)
-
+ Get a formatted letter (mark-down) to confirm keys via ordinary mail.
.. http:post:: <nexus>/ebics/subscriber/{id}/sendIni
Send INI message to the EBICS host.
-
.. http:post:: <nexus>/ebics/subscriber/{id}/sendHia
Send HIA message to the EBICS host.