diff --git a/.gitbook/assets/guides/onboarding_complete.png b/.gitbook/assets/guides/onboarding_complete.png new file mode 100644 index 00000000..a70b04a3 Binary files /dev/null and b/.gitbook/assets/guides/onboarding_complete.png differ diff --git a/.gitbook/assets/guides/onboarding_signup.png b/.gitbook/assets/guides/onboarding_signup.png new file mode 100644 index 00000000..da59a5bf Binary files /dev/null and b/.gitbook/assets/guides/onboarding_signup.png differ diff --git a/.gitbook/assets/guides/onboarding_verify_email01.png b/.gitbook/assets/guides/onboarding_verify_email01.png new file mode 100644 index 00000000..873d0ed7 Binary files /dev/null and b/.gitbook/assets/guides/onboarding_verify_email01.png differ diff --git a/.gitbook/assets/guides/onboarding_verify_email02.png b/.gitbook/assets/guides/onboarding_verify_email02.png new file mode 100644 index 00000000..7a6e4ca8 Binary files /dev/null and b/.gitbook/assets/guides/onboarding_verify_email02.png differ diff --git a/guides/api-guides/users/inviting-end-users.md b/guides/api-guides/users/inviting-end-users.md index 65f30f2f..2cbe0bba 100644 --- a/guides/api-guides/users/inviting-end-users.md +++ b/guides/api-guides/users/inviting-end-users.md @@ -20,12 +20,12 @@ sequenceDiagram P->>+API: POST /end-users/invitations API-->>-P: 201 invitation object containing request_uri Note over H,P: There are different ways a holder can receive this link
- QR code that can be scanned
-Deeplink to click on - P->>P: Render QR for request
openid://request_uri=https://svx-api-sandbox.meeco.me/oidc/presentations/requests/{id}/jwt + P->>P: Render QR for request
openid://request_uri=https://api-sandbox.svx.exchange/oidc/presentations/requests/{id}/jwt TA-->>H: Email QR code / deeplink H->>W: Scan QR Code - W->>+API: GET https://svx-api-sandbox.meeco.me/oidc/presentations/requests/{id}/jwt + W->>+API: GET https://api-sandbox.svx.exchange/oidc/presentations/requests/{id}/jwt API-->>-W: return request_jwt W->>+W: Extract state and reciret_uri attributes from the request request_jwt W->>+API: POST /end_users/invitations/short_lived_access_token (token: state) diff --git a/guides/api-guides/vault/classification-hierarchies.md b/guides/api-guides/vault/classification-hierarchies.md index e9318f67..ffbb2407 100644 --- a/guides/api-guides/vault/classification-hierarchies.md +++ b/guides/api-guides/vault/classification-hierarchies.md @@ -17,13 +17,13 @@ A Classification Node is structured like The `$VAULT_ACCESS_TOKEN` can be grabbed from the user file you created in the [Onboarding to SVX](guides/onboarding-to-svx.md) guide. -All classification nodes can be queried by `GET /vault/classification_nodes`: +All classification nodes can be queried by `GET /classification_nodes`: ```bash curl --request GET \ - 'https://sandbox.meeco.me/vault/classification_nodes' \ + "https://api-sandbox.svx.exchange/classification_nodes" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" ``` [API Docs](https://api-reference-sandbox.svx.exchange/) @@ -53,10 +53,10 @@ You must use `tag` as the default scheme. You can create a Classification node as follows ```bash - curl --request POST 'https://sandbox.meeco.me/vault/classification_nodes' \ + curl --request POST "https://api-sandbox.svx.exchange/classification_nodes" \ -H "authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H 'content-type: application/json' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' \ + -H "content-type: application/json" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "classification_node": { @@ -106,10 +106,10 @@ Classification Nodes can be applied to Item Templates, Items and Slots. Most pro Single Classification Nodes may be applied to Item Templates: ```bash - curl --request POST 'https://sandbox.meeco.me/item_templates' \ + curl --request POST "https://api-sandbox.svx.exchange/item_templates" \ -H "authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H 'content-type: application/json' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' \ + -H "content-type: application/json" \ + -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ --data \ '{ "label": "Some Template", @@ -159,13 +159,13 @@ Result } ``` -This has two effects. First, the Item Template can be found via its Classification Node or Scheme name, e.g. queries `GET /vault/item_templates?by_classification=tag`, or `GET /vault/item_templates?by_classification=new_tag` should include the template. Second, new Items created with the Item Template will be classified with the Classification Node. +This has two effects. First, the Item Template can be found via its Classification Node or Scheme name, e.g. queries `GET /item_templates?by_classification=tag`, or `GET /item_templates?by_classification=new_tag` should include the template. Second, new Items created with the Item Template will be classified with the Classification Node. ```bash - curl --request POST "https://sandbox.meeco.me/vault/items" \ + curl --request POST "https://api-sandbox.svx.exchange/items" \ -H "content-type: application/json" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "item": { @@ -234,10 +234,10 @@ Classification nodes are added to Items by passing `classification_nodes_attribu Classification Node can be applied to both the Item and the Slots it contains. Unlike Item Templates, Items may have multiple classifications. ```bash - curl --request POST "https://sandbox.meeco.me/vault/items" \ + curl --request POST "https://api-sandbox.svx.exchange/items" \ -H "content-type: application/json" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "item": { @@ -303,7 +303,7 @@ Note that even if the Classification Node `name` property matches an existing No Classification Nodes can be added to Slots too: ```bash - curl --request POST "https://sandbox.meeco.me/items" \ + curl --request POST "https://api-sandbox.svx.exchange/items" \ -H "content-type: application/json" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ @@ -406,7 +406,7 @@ In this case the `new_slot` receives both an existing Classification Node and a ### Slots -Slots are usually given Classification Nodes via `POST /vault/items`, but you can add a classification to an existing Slot using `PUT /vault/slots/{id}`. +Slots are usually given Classification Nodes via `POST /items`, but you can add a classification to an existing Slot using `PUT /slots/{id}`. Slots cannot be searched by Classification Node or Scheme. diff --git a/guides/api-guides/vault/connections-and-sharing.md b/guides/api-guides/vault/connections-and-sharing.md index 6066c17b..3dda2133 100644 --- a/guides/api-guides/vault/connections-and-sharing.md +++ b/guides/api-guides/vault/connections-and-sharing.md @@ -103,7 +103,7 @@ classification_nodes: description: null ordinal: 3 background_color: null - image: https://sandbox.meeco.me/vault/images/ff1c25e9-530a-4103-b649-986631bcAAAAA + image: https://api-sandbox.svx.exchange/vault/images/ff1c25e9-530a-4103-b649-986631bcAAAAA scheme: meeco item: id: a3f632c8-f80f-47aa-9e26-aab15ad9ed63 diff --git a/guides/api-guides/vault/items-and-slots.md b/guides/api-guides/vault/items-and-slots.md index 7df4662b..9e240acf 100644 --- a/guides/api-guides/vault/items-and-slots.md +++ b/guides/api-guides/vault/items-and-slots.md @@ -19,14 +19,14 @@ For more information on Vault-specific terminology, see the [Vault overview](../ Items are created from templates, so we begin by listing all available Item templates: ```bash -curl --request GET 'https://sandbox.meeco.me/vault/item_templates' \ +curl --request GET "https://api-sandbox.svx.exchange/item_templates" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" ``` [API docs](https://api-reference-sandbox.svx.exchange/) -(Get `API_SUBSCRIPTION_KEY` by [signing up](https://www.meeco.me/signup) for the API, then use the CLI tool to [generate a User and access token]().) +If you don’t have access to the SVX API, follow the steps in [Onboarding to SVX](../../../guides/onboarding-to-svx.md), obtain an access token, and create an organisation. The response JSON object lists Templates under the `item_templates` key. Each Template object has a `slot_ids` list, which references Slots in the top-level `slots` list. @@ -120,9 +120,9 @@ Here's a sample of Item Templates you might get: You can get a specific Template using its `id` (replace `ITEM-TEMPLATE-ID`): ```bash -curl --request GET 'https://sandbox.meeco.me/vault/item_templates/ITEM-TEMPLATE-ID' \ - -H 'Authorization: Bearer $VAULT_ACCESS_TOKEN' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' +curl --request GET "https://api-sandbox.svx.exchange/item_templates/ITEM-TEMPLATE-ID" \ + -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" ``` [API docs](https://api-reference-sandbox.svx.exchange/) @@ -130,9 +130,9 @@ curl --request GET 'https://sandbox.meeco.me/vault/item_templates/ITEM-TEMPLATE- Or, to search Item Templates by matching `label` text (replace `SEARCH_TEXT`): ```bash -curl --request GET 'https://sandbox.meeco.me/vault/item_templates?like=SEARCH_TEXT' \ - -H 'Authorization: Bearer $VAULT_ACCESS_TOKEN' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' +curl --request GET "https://api-sandbox.svx.exchange/item_templates?like=SEARCH_TEXT" \ + -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" ``` [API docs](https://api-reference-sandbox.svx.exchange/) @@ -155,10 +155,10 @@ For now the new Item's Slots are left empty. A [later section](#encryption-of-us To create an Item you must give the name of an existing Item Template, and a label: ```bash - curl --request POST 'https://sandbox.meeco.me/vault/items' \ - -H 'Authorization: Bearer $VAULT_ACCESS_TOKEN' \ - -H 'content-type: application/json' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' \ + curl --request POST "https://api-sandbox.svx.exchange/items" \ + -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ + -H "content-type: application/json" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "template_name": "vehicle", @@ -284,10 +284,10 @@ It is possible to create a Custom Template which we can use to create our own It Only the `label` property is required, it will auto-generate a `name` (as described above). Since Item Templates are referenced by their name, the generated name must be unique. You can specify it separately if the label does not generate a unique name. ```bash - curl --request POST "https://sandbox.meeco.me/vault/item_templates" \ + curl --request POST "https://api-sandbox.svx.exchange/item_templates" \ -H "Content-Type: application/json" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ -H "authorization: Bearer $VAULT_ACCESS_TOKEN" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID"\ --data \ '{ "name": "example_custom_template", @@ -359,10 +359,10 @@ The new Template will look like this: Then, you can create an item from your new template: ```bash - curl --request POST "https://sandbox.meeco.me/vault/items" \ + curl --request POST "https://api-sandbox.svx.exchange/items" \ -H "content-type: application/json" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "item": { @@ -493,13 +493,13 @@ As the Vault cannot inspect the data, it is just a suggestion to the user. Type Slots are created either by cloning an Item Template, or via the `slots_attributes` property when creating an Item. Since they are keyed by `name`, either `label` or `name` must be non-empty on creation. -Slots are updated by calling `PUT /vault/items` with the new data in `slots_attributes`: +Slots are updated by calling `PUT /items` with the new data in `slots_attributes`: ```bash -curl --request PUT "https://sandbox.meeco.me/vault/items/bef961af-aa1f-4f1c-ac95-cdb41b3682db" \ +curl --request PUT "https://api-sandbox.svx.exchange/items/bef961af-aa1f-4f1c-ac95-cdb41b3682db" \ -H "content-type: application/json" \ -H "Authorization: Bearer $VAULT_ACCESS_TOKEN" \ - -H "Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY" \ + "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ --data \ '{ "item": { @@ -606,10 +606,10 @@ Thanks to the Item Template our new Item already has a list of empty Slots, and ```bash curl --request PUT \ - 'https://sandbox.meeco.me/vault/items/049740cb-ad1f-43d9-9254-ae25eba30f47' \ - -H 'Authorization: $VAULT_ACCESS_TOKEN' \ - -H 'content-type: application/json' \ - -H 'Meeco-Subscription-Key: $API_SUBSCRIPTION_KEY' \ + "https://api-sandbox.svx.exchange/items/049740cb-ad1f-43d9-9254-ae25eba30f47" \ + -H "Authorization: $VAULT_ACCESS_TOKEN" \ + -H "content-type: application/json" \ + -H "Meeco-Organisation-Id: $YOUR_ORGANISATION_ID" \ -d ' { "item": { @@ -670,7 +670,7 @@ The page on [Connections and Sharing](../vault/connections-and-sharing.md) cover ### Receiving A Share -You receive a shared item by calling `PUT https://sandbox.meeco.me/vault/incoming_shares/{share_id}/accept`. (This indicates you accept the share terms, if any). Next call `GET https://sandbox.meeco.me/vault/incoming_shares/{share_id}/item` and view the Item that has been created in your Vault. Note that `share.item_id` is the original Item's id, not the one in your Vault! +You receive a shared item by calling `PUT https://api-sandbox.svx.me/incoming_shares/{share_id}/accept`. (This indicates you accept the share terms, if any). Next call `GET https://api-sandbox.svx.me/incoming_shares/{share_id}/item` and view the Item that has been created in your Vault. Note that `share.item_id` is the original Item's id, not the one in your Vault! ### Owners @@ -683,6 +683,6 @@ An Item's owner is its original creator. The following table summarizes the how | `original_id` | null | `share.item_id` | | `share_id` | null | `share.id` | -As a result, if `item.share_id` is non-null, then it is a share you received, and you can view the share via `GET https://sandbox.meeco.me/vault/incoming_shares/{item.share_id}`. +As a result, if `item.share_id` is non-null, then it is a share you received, and you can view the share via `GET https://api-sandbox.svx.exchange/incoming_shares/{item.share_id}`. Owners have the ability to push updates of shared data, and can share the Item with anyone. Receivers of a shared Item can only share that Item if `item.sharing_mode` is `anyone`. diff --git a/guides/onboarding-to-svx.md b/guides/onboarding-to-svx.md index 8ea0c016..7e58cf41 100644 --- a/guides/onboarding-to-svx.md +++ b/guides/onboarding-to-svx.md @@ -1,4 +1,19 @@ -To onboard to Secure Value Exchange (SVX) you will first need to sign up. Navigate to our [sign up form](https://www.meeco.me/signup) to gain access to our Sandbox. Once your access has been approved, you will be able to [log in to the SVX Portal](https://portal-sandbox.securevalueexchange.com/login). From here you can: +To onboard to Secure Value Exchange (SVX) you will first need to sign up. + +## Signup to SVX +To sign up to SVX, navigate to our [sign up form](https://login-sandbox.securevalueexchange.com/signup). You will be presented with the SVX signup screen where you can enter your details, review Meeco’s Privacy Policy and Terms and Conditions, and create your account. +
Sign up to SVX form
+ +After submitting the form, an email will be sent to the address you provided. Follow the link in this email to verify your email address, then enter your email and password and select *Verify and Continue*. +
Verify your email address screen
+
Verify your email address screen
+ +Once verification is complete, you will land on the tenant admin page. A tenant is created under your company name and you are added as a tenant administrator for that tenant. +
+ Onboarding completed. The user is taken to the tenant admin page. +
+ +From here you can: * Use the Portal UI to manage workflows, and * Directly access the SVX Sandbox API. diff --git a/policies/developer-policy.md b/policies/developer-policy.md index adfb6528..e4c2aa62 100644 --- a/policies/developer-policy.md +++ b/policies/developer-policy.md @@ -8,12 +8,12 @@ description: What you need to know about using our sandbox APIs ## Developer Policy -Please read this policy to understand Meeco’s terms and conditions for the use of our APIs in the Developer Sandbox Environment at [https://www.meeco.me/signup](https://www.meeco.me/signup). +Please read this policy to understand Meeco’s terms and conditions for the use of our APIs in the Developer Sandbox Environment at [https://login-sandbox.securevalueexchange.com/signup](https://login-sandbox.securevalueexchange.com/signup). ### Sign Up -* Signing up allows you to create Subscription Keys which are used to authenticate you in all Sandbox API calls. -* Without active subscription keys it is not possible to use the portal to receive the correct responses from the Meeco Sandbox APIs. +* Signing up creates tenant admin access for you, which allows you to authenticate Sandbox API calls. +* Without this access, you will not be able to access Sandbox SVX APIs. * You must provide accurate information about you and your organization while registering. By signing up to the Meeco portal you agree to our terms and conditions and usage restrictions contained therein. ### System Availability & API Upgrade