feat: documenting android proxy and get a token services #50
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dhudec
reviewed
Jan 26, 2023
Comment on lines
+76
to
+86
| ### createSession | ||
|
|
||
| To retrieve sensitive data on Android, you'll need to create a `session` and use its `sessionKey` for making requests securely. | ||
| To accomplish this, simply call the `createSession` function like this: | ||
|
|
||
| ```kotlin showLineNumbers | ||
| val session = bt.createSession() | ||
| ``` | ||
|
|
||
| This returns a [CreateSessionResponse](/docs/api/applications/sessions#create-session-response-object) | ||
| which contains a `nonce` that needs to be used to [authorize the session](/docs/api/applications/sessions#authorize-session) before using it. |
There was a problem hiding this comment.
This should link to https://developers.basistheory.com/docs/guides/govern/sessions
Maybe at the end, add: "To learn more about how to authorize a session, read our guide Access Data Using Sessions"
dhudec
reviewed
Jan 26, 2023
| This function wraps the [get a token API endpoint](/docs/api/tokens/#get-a-token) to | ||
| be able to get a single strongly typed token. It then transforms the token's data to | ||
| value references which you can use to [set the value](/docs/sdks/mobile/android/types#methods) of your elements without touching | ||
| the plaintext value and getting into compliance scope. |
There was a problem hiding this comment.
nitpick: this doesn't sound quite right to me to say "getting into" here - to me "getting into" more equates to "learning about" or "being interested in"
Suggested change
| the plaintext value and getting into compliance scope. | |
| the plaintext value and pulling your application into compliance scope. |
dhudec
reviewed
Jan 26, 2023
| This function receives a [ProxyRequest](/docs/sdks/mobile/android/services#proxyrequest) and wraps the [proxy API endpoint](/docs/api/proxies/invoke-proxy) to | ||
| be able to proxy a request to a third party API. It then transforms the response to | ||
| value references which you can then use to [set the value](/docs/sdks/mobile/android/types#methods) of your elements without touching | ||
| the plaintext value and getting into compliance scope. |
There was a problem hiding this comment.
Suggested change
| the plaintext value and getting into compliance scope. | |
| the plaintext value and pulling your application into compliance scope. |
dhudec
reviewed
Jan 26, 2023
Comment on lines
+125
to
+126
| | `queryParams` | false | _Map<String, String>?_ | `emptyMap()` | Map of query parameters to include in the request. | | ||
| | `headers` | false | _Map<String, String>?_ | `emptyMap()` | Map of headers to include in the request. | |
There was a problem hiding this comment.
I'm having this thought late here in the docs, but technically, query params and headers can be repeated with the same name, so it might be more correct to make these some sort of array of pairs instead of maps. We may never run into that use case from here though, but if we do that would be a breaking change...
There was a problem hiding this comment.
interesting, the java sdk receives a map for headers but for query params it does receive a list of pairs instead
amkera
reviewed
Jan 26, 2023
| ### getToken | ||
|
|
||
| This function wraps the [get a token API endpoint](/docs/api/tokens/#get-a-token) to | ||
| be able to get a single strongly typed token. It then transforms the token's data to |
There was a problem hiding this comment.
Suggested change
| be able to get a single strongly typed token. It then transforms the token's data to | |
| retrieve a single strongly typed token. It then transforms the token's data to |
amkera
reviewed
Jan 26, 2023
| ### proxy | ||
|
|
||
| This function receives a [ProxyRequest](/docs/sdks/mobile/android/services#proxyrequest) and wraps the [proxy API endpoint](/docs/api/proxies/invoke-proxy) to | ||
| be able to proxy a request to a third party API. It then transforms the response to |
There was a problem hiding this comment.
Suggested change
| be able to proxy a request to a third party API. It then transforms the response to | |
| proxy a request to a third party API. It then transforms the response to |
amkera
reviewed
Jan 26, 2023
docs/sdks/mobile/android/types.mdx
Outdated
|
|
||
| <Alert> | ||
| When using <code>setValueRef</code> to keep a <code>TextElement</code> in sync with another element, or to set the text of an element, it is strongly recommended that | ||
| you make the element acted upon readonly by also setting <code>isEditable=false</code>. |
There was a problem hiding this comment.
Suggested change
| you make the element acted upon readonly by also setting <code>isEditable=false</code>. | |
| you make the element that is being acted upon a "readonly" element. This is possible by setting <code>isEditable=false</code>. |
amkera
reviewed
Jan 26, 2023
docs/sdks/mobile/android/types.mdx
Outdated
| When using <code>setValueRef</code> to keep a <code>TextElement</code> in sync with another element, it is strongly recommended that | ||
| you make the dependent element readonly by also setting <code>isEditable=false</code>. | ||
| <code>ElementValueReference</code> is a class that stores a reference to a value which can only be accessed by BasisTheoryElements, so that | ||
| you can reference data without touching the plaintext value and getting into compliance scope. |
There was a problem hiding this comment.
Suggested change
| you can reference data without touching the plaintext value and getting into compliance scope. | |
| you can reference data without touching the plaintext value and pulling your application into compliance scope. |
amkera
previously approved these changes
Jan 26, 2023
amkera
approved these changes
Jan 26, 2023
bt-platform-eng
pushed a commit
that referenced
this pull request
Jan 26, 2023
# [1.21.0](v1.20.2...v1.21.0) (2023-01-26) ### Features * documenting android proxy and retrieve token services ([#50](#50)) ([9222cf4](9222cf4))
|
🎉 This PR is included in version 1.21.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Testing required outside of automated testing?
Screenshots (if appropriate):
Rollback / Rollforward Procedure
Reviewer Checklist