Developers
There are two ways to put Onshore in your data’s path. Most teams use both.
| Tokenize at the source | Plug in where data flows | |
|---|---|---|
| How | Call an SDK or the data API, or embed secure components | Point your log collector, AI client or vendor calls at Onshore |
| Code changes | Some | None, or one URL |
| Best for | New fields, onboarding forms, your own database | Logs, chatbots, vendor APIs, helpdesks |
Addresses
Everything is served from your install’s host, over HTTPS:
| Path | Service |
|---|---|
https://<host>/v1/… | Data API: tokenize, detokenize, records, detect, cloak |
https://<host>/embed/rv.js | Secure components script |
https://<host>/control/v1/… | Control API: configuration |
https://<host>/control/scim/v2/… | SCIM |
https://<host>/logs/… | Log processor |
https://<host>/ai/<route>/v1/… | AI gateway |
https://<host>/proxy/<route>/… | HTTP proxy |
On Onshore Cloud, each region has its own names, such as vault.gb.onshorevault.com.
Vaults and fields
Every data call names a vault (such as v_live_13fcb69f22cd; test vaults start v_test_) and a field (such as national_id). Find both under Vaults.
Next
AuthenticationService accounts, key pairs and short-lived tokens.SDKsFull references for Node.js, Python, Go, Java, PHP, the web, iOS, Android and React Native.Task guidesStore, reveal, find, data subject requests, AI, secure components, testing and errors, step by step.API referenceEvery endpoint of the data, control and SCIM APIs, with schemas and a built-in client.
Start here
- Get credentials. Make a service account and key: Authentication.
- Pick your SDK and create a client: Node.js, Python, Go, Java, PHP.
- Store your first value in a test vault: Store values at the source.
- Reveal it under an access rule: Reveal values safely.
- Keep forms out of your servers with secure components: Collect and reveal in the front end.
Last updated on