Merge pull request #125 from nevermined-io/feat/add-nvm-api-keys

feat: add nvm api keys tutorial
nevermined-io · Jun 3, 2024 · 6600803 · 6600803
2 parents a41ebad + 8ebcc82
commit 6600803
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 7 deletions.
diff --git a/docs/tutorials/integration/nextjs-react-payments.mdx b/docs/tutorials/integration/nextjs-react-payments.mdx
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 3
+sidebar_position: 5
 description: How to integrate the Nevermined Payments library in a react application
 ---
 

diff --git a/docs/tutorials/integration/nvm-api-keys.mdx b/docs/tutorials/integration/nvm-api-keys.mdx
@@ -0,0 +1,21 @@
+---
+sidebar_position: 4
+description: What is a Nvm Api Key and how to obtain it
+---
+
+# What is a Nvm Api Key? How to obtain it and how to use it
+
+A Nevermined Api key is the simpler way to integrate with the Nevermined ecosystem. It's a string that contains data that identifies the session key of the account abstraction and some extra data as the marketplace auth token. It works similar to a jwt but for blockchain accounts. You can find more in [zeroDev docs](https://docs.zerodev.app/sdk/plugins/session-keys).
+
+## How to obtain a Nvm Api Key
+
+1. Go to the [Nevermined App](https://app.nevermined.app/).
+2. Click on the `Account` button on the top right corner.
+![Profile dropdwonw](/images/tutorials/NVM_api_key_profile_dropdown.jpeg)
+3. Go to the API tab. Click on the `Generate Nvm Api Key` button.
+![Generate Nvm Api Key](/images/tutorials/NVM_api_key_generation_page.jpeg)
+4. Sign the session key. It will take some seconds.
+5. Copy the generated Nvm Api Key. It will be only shown once.
+![Copy Nvm Api Key](/images/tutorials/NVM_api_key_copy.jpeg)
+6. You can see the list of generated Nvm Api Keys in the API tab. And you can revoke them if needed.
+![List of Nvm Api Keys](/images/tutorials/NVM_api_key_list.jpeg)
diff --git a/docs/tutorials/integration/python-integration.mdx b/docs/tutorials/integration/python-integration.mdx
@@ -1,12 +1,18 @@
 ---
-sidebar_position: 3
+sidebar_position: 6
 description: How to integrate the Nevermined Payments Python library
 ---
 
 # Tutorial on how to use the Nevermined Payments Protocol in Python
 
 The objective of this library is to make possible the integration of Nevermined payments in the Python code ecosystem. This library provides a set of functions to interact with the Nevermined network, including the ability to register subscriptions and subscribe to web services and get the JWT access token to call them.
 
+:::info
+
+In a previous tutorial we showed [what is a Nvm Api Key and how to obtain it](nvm-api-keys).
+
+:::
+
 ## Installation
 
 Install the [nevermined payments library](https://pypi.org/project/payments-py/) using pip:
@@ -31,11 +37,6 @@ payments = Payments(nvm_api_key=nvm_api_key, environment=Environment.appTesting,
 
 ```
 
-:::info
-
-You can find your `nvm_api_key` in the [your profile page](https://testing.nevermined.app/en/account). Just click the button and sign the session key. It will take some seconds.
-
-:::
 
 ### Using payments library
 

diff --git a/static/images/tutorials/NVM_api_key_copy.jpeg b/static/images/tutorials/NVM_api_key_copy.jpeg
diff --git a/static/images/tutorials/NVM_api_key_generation_page.jpeg b/static/images/tutorials/NVM_api_key_generation_page.jpeg
diff --git a/static/images/tutorials/NVM_api_key_list.jpeg b/static/images/tutorials/NVM_api_key_list.jpeg
diff --git a/static/images/tutorials/NVM_api_key_profile_dropdown.jpeg b/static/images/tutorials/NVM_api_key_profile_dropdown.jpeg