Skip to content

Commit 61be70a

Browse files
authored
Merge pull request #9 from modzy/update/apiKeys
api keys description
2 parents 4abf5fc + e266796 commit 61be70a

File tree

2 files changed

+19
-1
lines changed

2 files changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,30 @@ Add the dependency in your `pom.xml` file:
3838
</dependency>
3939
```
4040

41+
42+
### Get your API key
43+
44+
45+
46+
API keys are security credentials required to perform API requests to Modzy. Our API keys are composed of an ID that is split by a dot into two parts: a public and private part.
47+
48+
The *public* part is the API keys' visible part only used to identify the key and by itself, it’s unable to perform API requests.
49+
50+
The *private* part is the public part's complement and it’s required to perform API requests. Since it’s not stored on Modzy’s servers, it cannot be recovered. Make sure to save it securely. If lost, you can [replace the API key](https://models.modzy.com/docs/users-keys/api-keys/replace-API-key).
51+
52+
53+
Find your API key in your user profile. To get your full API key click on "Get key":
54+
55+
<img src="key.png" alt="get key" width="10%"/>
56+
57+
58+
4159
## Initialize
4260

4361
Once you have a `model` and `version` identified, get authenticated with your API key.
4462

4563
```java
46-
ModzyClient modzyClient = new ModzyClient("http://url.to.modzy/api", "my_key.modzy");
64+
ModzyClient modzyClient = new ModzyClient("http://url.to.modzy/api", "API Key");
4765
```
4866

4967
## Basic usage

key.png

17.4 KB
Loading

0 commit comments

Comments
 (0)