diff --git a/docs/build-with-powerloom/snapshotter-node/core-api/index.md b/docs/build-with-powerloom/snapshotter-node/core-api/index.md index 1c56c92..cdacaef 100644 --- a/docs/build-with-powerloom/snapshotter-node/core-api/index.md +++ b/docs/build-with-powerloom/snapshotter-node/core-api/index.md @@ -6,4 +6,31 @@ sidebar_position: 0 Core API facilitates access to the finalized protocol state on the smart contract running on the anchor chain. Although it is possible to directly query the smart contract, it is not recommended as it is expensive and slow. Instead, you can use the Core API to access the finalized state. Every snapshotter node runs a Core API service that can be accessed by other services or applications. -We have hosted snapshotter nodes for UniswapV2 and Zkevm Quests on the PowerLoom Protocol's testnet. You can interact with those endpoints directly from the next couple of sections. \ No newline at end of file +We have hosted snapshotter nodes for UniswapV2 and Zkevm Quests on the PowerLoom Protocol's testnet. You can interact with those endpoints directly from the next couple of sections. + +## Hosted API +![Changing Base URL in UI](/images/base_url_selection.png) + +All the API endpoints are available for the given protocols. + +``` +💡 While the endpoints allow nominal usage for public access without an API key, we **do not** recommend them for developers. Doing so can severely restrict access to your IP address. +``` + + +### Steps to generate API key for privileged access + +Follow the steps to generate the API key to access the mentioned API endpoints in the postman collection: + +1. Visit [Snapshotter API Dashboard](https://snapshotter-api-dashboard.powerloom.io/) and enter your email to Sign In. + +![Screenshot 2022-11-30 at 10.56.19 PM.png](/images/Screenshot_2022-12-14_at_6.21.41_PM.png) + +1. You will see a pop-up as shown below. *Note: Don’t close this tab* + + ![Screenshot 2022-11-30 at 10.57.36 PM.png](/images/Screenshot_2022-12-14_at_6.21.51_PM.png) + +2. Login through the link provided on the email and go back to the [Dashboard](https://pooler-api-dashboard.powerloom.io/) tab to get the API key. It should look as shown below + + ![Screenshot 2022-11-30 at 11.02.31 PM.png](/images/Screenshot_2022-12-14_at_6.27.54_PM.png) + \ No newline at end of file diff --git a/docs/build-with-powerloom/snapshotter-node/core-api/sidebar.js b/docs/build-with-powerloom/snapshotter-node/core-api/sidebar.js index 2614843..c4bdd31 100644 --- a/docs/build-with-powerloom/snapshotter-node/core-api/sidebar.js +++ b/docs/build-with-powerloom/snapshotter-node/core-api/sidebar.js @@ -1 +1,58 @@ -module.exports = [{"type":"doc","id":"Snapshotter Core API/snapshotter-core-api"},{"type":"category","label":"UNTAGGED","items":[{"type":"doc","id":"Snapshotter Core API/health-check-health-get","label":"Health Check","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-current-epoch-current-epoch-get","label":"Get Current Epoch","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-epoch-info-epoch-epoch-id-get","label":"Get Epoch Info","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-project-last-finalized-epoch-info-last-finalized-epoch-project-id-get","label":"Get Project Last Finalized Epoch Info","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-data-for-project-id-epoch-id-data-epoch-id-project-id-get","label":"Get Data For Project Id Epoch Id","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-finalized-cid-for-project-id-epoch-id-cid-epoch-id-project-id-get","label":"Get Finalized Cid For Project Id Epoch Id","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-snapshotter-overall-status-internal-snapshotter-status-get","label":"Get Snapshotter Overall Status","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-snapshotter-project-level-status-internal-snapshotter-status-project-id-get","label":"Get Snapshotter Project Level Status","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-snapshotter-epoch-processing-status-internal-snapshotter-epoch-processing-status-get","label":"Get Snapshotter Epoch Processing Status","className":"api-method get"},{"type":"doc","id":"Snapshotter Core API/get-task-status-post-task-status-post","label":"Get Task Status Post","className":"api-method post"}]}]; \ No newline at end of file +module.exports = [{ + "type": "doc", + "id": "Snapshotter Core API/snapshotter-core-api" +}, { + "type": "category", + "label": "UNTAGGED", + "items": [{ + "type": "GET", + "id": "Snapshotter Core API/health-check-health-get", + "label": "Health Check", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-current-epoch-current-epoch-get", + "label": "Get Current Epoch", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-epoch-info-epoch-epoch-id-get", + "label": "Get Epoch Info", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-project-last-finalized-epoch-info-last-finalized-epoch-project-id-get", + "label": "Get Project Last Finalized Epoch Info", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-data-for-project-id-epoch-id-data-epoch-id-project-id-get", + "label": "Get Data For Project Id Epoch Id", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-finalized-cid-for-project-id-epoch-id-cid-epoch-id-project-id-get", + "label": "Get Finalized Cid For Project Id Epoch Id", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-snapshotter-overall-status-internal-snapshotter-status-get", + "label": "Get Snapshotter Overall Status", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-snapshotter-project-level-status-internal-snapshotter-status-project-id-get", + "label": "Get Snapshotter Project Level Status", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-snapshotter-epoch-processing-status-internal-snapshotter-epoch-processing-status-get", + "label": "Get Snapshotter Epoch Processing Status", + "className": "api-method get" + }, { + "type": "doc", + "id": "Snapshotter Core API/get-task-status-post-task-status-post", + "label": "Get Task Status Post", + "className": "api-method post" + }] +}]; \ No newline at end of file diff --git a/static/images/Screenshot_2022-12-14_at_6.21.41_PM.png b/static/images/Screenshot_2022-12-14_at_6.21.41_PM.png new file mode 100644 index 0000000..995e22f Binary files /dev/null and b/static/images/Screenshot_2022-12-14_at_6.21.41_PM.png differ diff --git a/static/images/Screenshot_2022-12-14_at_6.21.51_PM.png b/static/images/Screenshot_2022-12-14_at_6.21.51_PM.png new file mode 100644 index 0000000..b89fc8e Binary files /dev/null and b/static/images/Screenshot_2022-12-14_at_6.21.51_PM.png differ diff --git a/static/images/Screenshot_2022-12-14_at_6.27.54_PM.png b/static/images/Screenshot_2022-12-14_at_6.27.54_PM.png new file mode 100644 index 0000000..3b5ea5a Binary files /dev/null and b/static/images/Screenshot_2022-12-14_at_6.27.54_PM.png differ diff --git a/static/images/base_url_selection.png b/static/images/base_url_selection.png new file mode 100644 index 0000000..0e45040 Binary files /dev/null and b/static/images/base_url_selection.png differ