Added doc page description markdown. #7
Merged
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
|
@sandervdo please 👀 |
sandervdo
reviewed
Apr 26, 2018
DESCRIPTION.md
Outdated
|
|
||
| - The bunq API is organised around REST. JSON will be returned in almost all responses from the API, including errors but excluding binary (image) files. | ||
| - All calls made through bunq Doc are executed on a sandbox environment. No real money is used and no transactions to external bank accounts can be done. | ||
| - Please configure your implementation to send it's API requests to https://sandbox.public.api.bunq.com/v1. |
DESCRIPTION.md
Outdated
| - The bunq API is organised around REST. JSON will be returned in almost all responses from the API, including errors but excluding binary (image) files. | ||
| - All calls made through bunq Doc are executed on a sandbox environment. No real money is used and no transactions to external bank accounts can be done. | ||
| - Please configure your implementation to send it's API requests to https://sandbox.public.api.bunq.com/v1. | ||
| - There is an Android client available of our app that connects to the bunq Sandbox environment. |
There was a problem hiding this comment.
There is an version of the Android app that connect to ...
|
|
||
| ## Get Started | ||
|
|
||
| 1. Create a user account with your phone. Afterwards, you can use this account to create an API key from which you can make API calls. You can find API key management under 'Profile' -\> 'Security'. |
There was a problem hiding this comment.
We have Tinker for this now?
There was a problem hiding this comment.
Nein. Tinker is for playtime not actual implementation. Then you should indeed go and manually create the key 😊
DESCRIPTION.md
Outdated
| - We use RSA Keys for signatures headers and encryption. | ||
| - API calls must contain a valid authentication token in the headers. | ||
| - The auto logout time that you've set for your user account is also effective for your sessions. If a request is made 30 minutes before a session expires, the session will automatically be extended. | ||
| ## Device Registration |
There was a problem hiding this comment.
I believe the new strict Markdown requires enters around headers.
Can you doublecheck?
DESCRIPTION.md
Outdated
| ### Using our SDKs | ||
| 1. In order to start making calls with the bunq API, you must first register your API key and device and create a session. | ||
| 2. In the SDKs, we group these actions and call it "creating an API context". | ||
| 3. You can find more information on our GitHub page |
There was a problem hiding this comment.
Missing . at the end, and would make GitHub page clickable.
sandervdo
suggested changes
Apr 26, 2018
|
|
||
| While this system is already implemented in our SDKs, you should always follow the guidelines on this page when using the bunq API to make sure you correctly sign your calls. | ||
|
|
||
| The signatures are created using the SHA256 cryptographic hash function and included (encoded in base 64) in the `X-Bunq-Client-Signature` request header and `X-Bunq-Server-Signature` response header. The data to sign is the following: |
There was a problem hiding this comment.
Is still reflecting the changes in the capitalisation of this header name?
There was a problem hiding this comment.
Arg. Lets create follow up issue for this one.
|
@sandervdo pushed |
sandervdo
approved these changes
Apr 26, 2018
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.
No description provided.