prysm-pulse/hack/keymanager-api/README.md
james-prysm 11f50453fc
Keymanager api postman test collection (#10209)
* initial commit

* adding keymanager api repo url

* updated postman collection

* removing unused folder

* removing validator build

* Update hack/keymanager-api/README.md

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update hack/keymanager-api/README.md

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

* Update hack/keymanager-api/README.md

Co-authored-by: Radosław Kapka <rkapka@wp.pl>

Co-authored-by: Radosław Kapka <rkapka@wp.pl>
2022-02-09 16:48:08 +00:00

26 lines
898 B
Markdown

# Keymanager API
https://github.com/ethereum/keymanager-APIs
## Postman
You can use Postman to test the API. https://www.postman.com/
### Postman collection
In this package you will find the Postman collection for the keymanager API.
You can import this collection in your own Postman instance to test the API.
#### Updating the collection
The collection will need to be exported and overwritten to update the collection. A PR should be created once the file
is updated.
#### Authentication
Our keymanager API requires a valid bearer token to run the keymanager.
You can retrieve this bearer token from the URL displayed when running `validator --web`
i.e. `http://127.0.0.1:7500/initialize?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.e30.BEuFWr-FpKIlJEIjgmujTQJlJF2aJRaUfFiuTBYVL3k`
The token can be copied and pasted into the authorization tab of each Postman request to authenticate.