Skip to content

Commit

Permalink
Merge pull request #53 from nevermined-io/gerriesmits-patch-22-1
Browse files Browse the repository at this point in the history
Update 05-register-webservice.md
  • Loading branch information
gerriesmits authored Jun 23, 2023
2 parents c94e8d2 + bf3175a commit a547991
Showing 1 changed file with 47 additions and 24 deletions.
71 changes: 47 additions & 24 deletions docs/tutorials/05-register-webservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ You can't register an asset without first configuring a Smart Subscription. So i

## Before you start

Currently, the Nevermined App is deployed on the Polygon, Gnosis and Arbitrum networks (plus on their respective testnets).
Currently, the Nevermined App is deployed on the [Polygon](https://matic.nevermined.app), [Gnosis](https://gnosis.nevermined.app) and [Arbitrum](https://nevermined.app) networks (plus on their respective testnets).

In order to interact with that network you need to:

Expand All @@ -29,78 +29,101 @@ These are the steps to make your web service accessible to holders of your Smart
- Click on the New button in the top right to go the New Asset page.
- Click on the “Create Asset” button of the Web Service box.

![Create a new Asset page](../images/tutorials/01_New_Subscription.png)
<p align="center"><img src="../images/tutorials/04_01_New_Subscription.png" /></p>

### 2. Add the web service metadata
### 2. Describe the web service with metadata

Provide a short title.
#### Provide a short title

#### Add a description
Use the description box to explain to potential users what your web service is about. Some examples:
- _An open source summarizer specialised in scientific research_
- _A chatbot-style AI Agent that generates quotes based on Elvis lyrics. Built using Lllama Index and an open source LLM. Good for devs who want to have some fun, build a Discord bot,..._

#### Include tags
Add tags to help buyers find your AI Web Service in the Nevermined marketplace.
Click the + symbol to add new tags.
Click the '+' symbol to add new tags.

![Add Web Service metadata page](../images/tutorials/06_New_Service_01.png)
<p align="center"><img src="../images/tutorials/05-01-Webservice-Describe.png" /></p>

### 3. Configure the attributes of the web service

In the next page, you add all the endpoint APIs of your AI agent or model (e.g. <https://myapi.example.com/v1>).
### 3. Define the attributes of the web service

#### Include the endpoint URL
Add one or more endpoint APIs of your AI agent or model (e.g. <https://myapi.example.com/v1>).
Paste the link and click on the **“+”** button

Note that you can use this URL field to specify regular expressions. This can be useful when you want to expose multiple links at once. For example:
<https://myapi.example.com/(.*)> will expose all the endpoints under the same domain.

![Add Web Service details page](../images/tutorials/07_New_Service_02.png)
<p align="center"><img src="../images/tutorials/05-02-Webservice-Content.png" /></p>


### 4. Add the access token
#### Add the access token

Next, you add an access token to your web service. Nevermined can protect the access to a web service that uses a HTTP Bearer token for authorization. Your access token is encrypted and will always be kept private.
Next, you add an access token to your web service.
This is the password for that enables connection to your web service. You can get it from the web service config file. Nevermined can protect the access to a web service that uses a HTTP Bearer token for authorization. Your access token is encrypted and will always be kept private.

### 5. Add a sample link
#### Add a sample link

Give your potential buyers an idea of what they can expect. Add a test link showing what your AI is about.

### 6. More information about your web service
#### More information about your web service

Give a broad description of the AI web service.
This can include:
- What can the web service be used for?
- Who will be interested in the web service?
- What kind of data does the web service require? What is the format of that data?
- How long can the web service be used for?

### 4. Add integration instructions

Give specific info about how developers can integrate your Web Service. For example:
- Tech Spec
- API Calls
- Supported formats
- Response info (error messages etc)

<p align="center"><img src="../images/tutorials/05-03-Webservice-Integration.png" /></p>

You can also add a visual that gives more info about your Al Web Service. Example: an image of Elvis.

Add any information for developers about how to integrate your web service.

You can also add an image to add a visual description of the web service you're making available.
### 5. Choose a subscription plan

### 7. Choose a subscription plan
Next, you need to specify which subscription a user needs to purchase to get access to your web service.

Next, you need to specify what type of subscription a user requires to get access to your web service.
![Associate a subscription to a web service page](../images/tutorials/08_New_Service_03.png)
<p align="center"><img src="../images/tutorials/05-04-Webservice-Plan.png" /></p>

:::Pro tip
If you want your web service to be available via different plans, you can go through this process once more.
Register the asset again and add it to another Smart Subscription plan. For now ;-)
:::

### 8. Review everything is okay
### 6. Review everything is okay

Finally, review your web service subscription.
Click on “Create” if everything looks good. Or go “Back” if you want to modify anything.
![Add Web Service summary page](../images/tutorials/09_New_Service_04.png)
<p align="center"><img src="../images/tutorials/05-05-Webservice-Review.png" /></p>

### 9. Web service registration
### 7. Web service registration

The Nevermined App will register the new web service on the blockchain. This will require you to sign one transaction in your MetaMask wallet. As explained in ‘Getting Ready’, this requires a little bit of gas tokens to pay for the transaction fees.
![Register Web Service page](../images/tutorials/10_New_Service_05.png)

---

### 10. Distribute and make some money
### 8. Distribute and make some money

You’re done!
Go to your dashboard to get an overview of your Smart Subscription(s) and the web service(s) associated with it.

![Publisher dashboard page](../images/tutorials/11_Publisher_Dashboard_no_balance.png)<br/>
<p align="center"><img src="../images/tutorials/05-06-Webservice-Dashboard.png" /></p>

Click on the web service to go the Asset Detail page.

Share this URL with potential buyers. They can use the 'Buy Now' button to purchase directly from you.
In addition, people can also automatically discover your AI web service in the Nevermined Marketplace.

![New web service details page](../images/tutorials/12_Service_details.png)
<p align="center"><img src="../images/tutorials/05-07-Webservice-AssetPage.png" /></p>

0 comments on commit a547991

Please sign in to comment.