-
Notifications
You must be signed in to change notification settings - Fork 19
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.
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
Added doc page description markdown. #7
Conversation
@sandervdo please 👀 |
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 was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
its
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We have Tinker for this now?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing .
at the end, and would make GitHub page
clickable.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
||
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is still reflecting the changes in the capitalisation of this header name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Arg. Lets create follow up issue for this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@sandervdo pushed |
No description provided.