diff options
author | Christian Grothoff <christian@grothoff.org> | 2017-12-14 13:39:33 +0100 |
---|---|---|
committer | Christian Grothoff <christian@grothoff.org> | 2017-12-14 13:39:42 +0100 |
commit | aec472510d565e4435334efbca131adc2116e59e (patch) | |
tree | 1537555048ffea41dfd3537fcc5129e4a763ffd3 | |
parent | 07272c76970ba46170e8c0a8e3913bd9b44c4248 (diff) | |
download | docs-aec472510d565e4435334efbca131adc2116e59e.tar.gz docs-aec472510d565e4435334efbca131adc2116e59e.tar.bz2 docs-aec472510d565e4435334efbca131adc2116e59e.zip |
remove /admin APIs from exchange specification
-rw-r--r-- | api-exchange.rst | 151 |
1 files changed, 0 insertions, 151 deletions
diff --git a/api-exchange.rst b/api-exchange.rst index 507eb568..8950d1b4 100644 --- a/api-exchange.rst +++ b/api-exchange.rst @@ -1346,157 +1346,6 @@ Refunds pub: EddsaPublicKey; } ------------------------------- -Administrative API: Key update ------------------------------- - - .. note:: - - This is not yet implemented (no bug number yet, as we are not sure we will - implement this; for now, adding new files to the directory and sending a - signal to the exchange process seems to work fine). - -New denomination and signing keys can be uploaded to the exchange via the -HTTP interface. It is, of course, only possible to upload keys signed -by the exchange's master key. Furthermore, this API should probably only -be used via loopback, as we want to protect the private keys from -interception. - -.. http:POST:: /admin/add/denomination_key - - Upload a new denomination key. - - **Request:** - - .. code-block:: tsref - - { - // Public part of the denomination key - denom_info: any: - - // Private RSA key - denom_priv: RsaPrivateKey; - } - - -.. http:POST:: /admin/add/sign_key - - Upload a new signing key. - - **Request:** - - .. code-block:: tsref - - { - // Public part of the signing key - sign_info: any; - - // Private EdDSA key - sign_priv: EddsaPrivateKey; - } - -.. _add-incoming: - -------------------------------------- -Administrative API: Bank transactions -------------------------------------- - -.. http:POST:: /admin/add/incoming - - Notify exchange of an incoming transaction to fill a reserve. - - **Request:** - - .. code-block:: tsref - - { - // Reserve public key - reserve_pub: EddsaPublicKey; - - // Amount transferred to the reserve - amount: Amount; - - // When was the transaction executed - execution_date: Timestamp; - - // Sender's wire account details, so that the exchange knows from whom the - // money comes from (and can possibly refund it). The details - // given here must be in a wire format supported by the exchange. - sender_account_details: any; - - // The wire details given here should include an unique identifier - // for each transaction. The exchange will check that the details - // given are unique, and if the wire details are identical to previous - // wire details will treat the request as a duplicate and not actually - // do any update. This is true even if the amount or execution date - // differs. - // - // Note that the exchange does not interpret these details in any - // way, other than for "being unique". They are stored for diagnostics - // and auditing. - transfer_details: any; - } - - **Response:** - - :status 200: - The operation succeeded. The body is an `AddIncomingResponse`_ object. - :status 403: - the client is not permitted to add incoming transactions. The request may - be disallowed by the configuration in general or restricted to certain IP - addresses (i.e. loopback-only). - - - .. _AddIncomingResponse: - .. code-block:: tsref - - interface AddIncomingResponse { - // The string constant `NEW` or `DUP` to indicate whether the transaction - // was truly added to the DB or whether it already existed in the DB - status: string; - } - -.. http:POST:: /admin/add/outgoing - - Notify exchange about the completion of an outgoing transaction satisfying a - /deposit request. In the future, this will allow merchants to obtain details - about the /deposit requests they send to the exchange. - - .. note:: - - This is not yet implemented (no bug number yet either). - - **Request:** - - .. code-block:: tsref - - { - coin_pub: CoinPublicKey; - - // Amount transferred to the merchant - amount: Amount; - - // Transaction identifier in the wire details - transaction: number; - - // `Wire transaction details <wireformats>`_, as originally specified by the merchant - wire: Object; - } - - **Response** - - :status 200: The request was successful. - :status 403: the client is not permitted to add outgoing transactions - - If the request was successful, the response has the following format: - - .. code-block:: tsref - - { - // The string constant `NEW` or `DUP` to indicate whether the transaction - // was truly added to the DB or whether it already existed in the DB - status: string; - } ------------ The Test API |