Skip to content
Snippets Groups Projects
Commit 814fa60c authored by Phil Höfer's avatar Phil Höfer
Browse files

Fix typos and outdated info.

parent 2af80380
No related branches found
No related tags found
No related merge requests found
Pipeline #8026 passed
...@@ -4,7 +4,7 @@ Keymanager supports a JSON API to manage and query keys. ...@@ -4,7 +4,7 @@ Keymanager supports a JSON API to manage and query keys.
## Authentication ## Authentication
API access is granted only authenticated you need to supply an Authorization header with every request. Most API methods are only available authenticated. You need to supply an Authorization header with those requests.
``` ```
Authorization: Bearer <API-Key> Authorization: Bearer <API-Key>
...@@ -12,8 +12,8 @@ Authorization: Bearer <API-Key> ...@@ -12,8 +12,8 @@ Authorization: Bearer <API-Key>
## `POST /api/json/key/create` ## `POST /api/json/key/create`
Creates a key and charges it by specified amount. Creates a Order to do so. A note can be attached to the Order. Creates a key and charges it by the specified amount. Creates a order to do so. A note can be attached to the order.
`manual` is currently the only valid payment processor for API. `manual` is currently the only valid payment processor for API use.
Can take either amount or price. If both supplied only amount is taken into account. Can take either amount or price. If both supplied only amount is taken into account.
### Parameters ### Parameters
...@@ -28,7 +28,7 @@ Can take either amount or price. If both supplied only amount is taken into acco ...@@ -28,7 +28,7 @@ Can take either amount or price. If both supplied only amount is taken into acco
### Example Response ### Example Response
Successfull discharge will have a response code of `201` Successfull discharge will have a response code of `201`
If the key cannot be charged because it is already charged with too many Orders response code will be `403` If the key cannot be charged because it is already charged with too many orders and the response code will be `403`
```json ```json
{ {
...@@ -88,8 +88,8 @@ Successfull discharge will have a response code of `201` ...@@ -88,8 +88,8 @@ Successfull discharge will have a response code of `201`
## `POST /api/json/key/:key/charge` ## `POST /api/json/key/:key/charge`
Charges a key by specified amount. Creates a Order to do so. A note can be attached to the Order. Charges a key by specified amount. Creates a Order to do so. A note can be attached to the order.
`manual` is currently the only valid payment processor for API. `manual` is currently the only valid payment processor for API use.
Can take either amount or price. If both supplied only amount is taken into account. Can take either amount or price. If both supplied only amount is taken into account.
### Parameters ### Parameters
...@@ -117,7 +117,7 @@ If the key cannot be charged because it is already charged with too many Orders ...@@ -117,7 +117,7 @@ If the key cannot be charged because it is already charged with too many Orders
## `GET /api/json/token/pubkey` ## `GET /api/json/token/pubkey`
Retrieves the pubkey the server is using currently for token signatures. Retrieves the pubkey the server is using currently for token signatures.
This Method does not require authentication This method does not require authentication
### Example Response ### Example Response
...@@ -135,7 +135,7 @@ This Method does not require authentication ...@@ -135,7 +135,7 @@ This Method does not require authentication
Signs submitted blinded tokens with the servers private key. The submitted key needs to hold a charge for each token or the request will fail. Signs submitted blinded tokens with the servers private key. The submitted key needs to hold a charge for each token or the request will fail.
The Key will be discharged by this action. The Key will be discharged by this action.
You cannot submit more than 10 tokens to be signed. You cannot submit more than 10 tokens to be signed.
This Method does not require authentication This method does not require authentication
### Parameters ### Parameters
...@@ -201,7 +201,7 @@ If any validation errors (signature, token format, etc.) occured response code w ...@@ -201,7 +201,7 @@ If any validation errors (signature, token format, etc.) occured response code w
## `POST /api/json/token/use` ## `POST /api/json/token/use`
Uses supplied Tokens to be consumed for MetaGer search. All supplied Tokens will be invalid after this action. Uses supplied tokens to be consumed for MetaGer search. All supplied tokens will be invalid after this action.
You cannot submit more than 10 tokens to be used. You cannot submit more than 10 tokens to be used.
### Parameters ### Parameters
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment