Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Further updates to Reference -> Overview #830

Merged
merged 2 commits into from
Jul 1, 2022
Merged

Further updates to Reference -> Overview #830

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a112a30
Further updates to `Reference -> Overview`
geel9 Jun 30, 2022
e6d6b3e
Fix `Services` section being included in `Java` tab
geel9 Jun 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/reference/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
# Overview

If you are ready to begin integrating the SDK, make sure you have an SDK installed and configured. You can install each SDK by following the instructions in each page under **Build** in the sidebar.

When using the SDK, you can pass parameters to the default service constructors and use the provided methods to set different active profiles.
This section serves as the reference for the Trinsic API, which can be accessed using any of our [SDKs](/cli/).

## Authentication
### Auth Tokens
Authentication with the Trinsic platform operates off of auth tokens, which are strings that operate similarly to API keys.
Authentication with the Trinsic platform uses auth tokens, which are strings that operate similarly to API keys.

Unlike API keys, however, Trinsic utilizes [zero-knowledge proofs](/learn/platform/security) to sign SDK calls using an auth token, without ever transmitting the auth token itself down the wire. This provides increased security compared to API keys, while being more convenient than other public/private key schemes.
Unlike API keys, however, Trinsic utilizes [zero-knowledge proofs](/learn/platform/security) to sign SDK calls using an auth token, without ever transmitting the auth token itself down the wire. This provides increased security compared to API keys, while being more convenient than other auth schemes, such as public/private tokens.

### Custom Protection of Auth Tokens

We provide helper methods to [protect](/reference/services/account-service#protect) auth tokens -- enabling you to perform custom security operations. An auth token, once protected with a code, is unusable until unprotected with that same code. Protection and unprotection and performed entirely on-device.
We provide helper methods to [protect](/reference/services/account-service#protect) auth tokens -- enabling you to perform custom security operations. An auth token, once protected with a code, is unusable until unprotected with that same code. Protection and unprotection are performed entirely on-device.

### Using Auth Tokens in the SDK

Expand Down Expand Up @@ -59,7 +57,9 @@ You can also manually set the auth token used by the SDK (such as when loading a
[SetAuthTokenSample](../../java/src/test/java/trinsic/AccountServiceTest.java) inside_block:setAuthTokenSample
```
<!--/codeinclude-->
## SDK Services


## Services
Our SDK is broken down into the following logical services, each of which is accessible through a single `TrinsicService` instance:

- [Account Service](./services/account-service.md)
Expand Down