We need a wiki page that documents how we got api key to Västtrafik #821
Labels
No labels
_CRITICAL_
API
app
backEnd
Blocked, waiting for further changes
bug
cleanup
close
design
duplicate
enhancement
feature request
frontEnd
help wanted
invalid
low priority
needs input
needs review
project documentation
question
research
reviewed
script
security
SQL
style
testing
topLevel
wontfix
No milestone
No project
4 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
Andras/BoundlessFlowCampus2K#821
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Description
During the customer meeting the customer suggested that we should document how we got the apikey for Västtrafik.
What should be done
I'm guessing I'm writing this?
@a24vinla wrote in #821 (comment):
That would be best yes!
@a24vinla wrote in #821 (comment):
Yes
Link to wiki page
I have not written about the usage of the API, except copied the headers used for other API's. I have also avoided writing about the license/terms since I don't want to misrepresent/paraphrase legal documents
The wiki page gives a clear overview of how API access is handled through the Västtrafik developer platform and explains the relationship between accounts, applications, and access tokens in an understandable way. The sections about token validity and restrictions are also useful and help clarify important limitations and responsibilities when using the APIs.
The structure is easy to follow, and the inclusion of licensing and terms of use is a good addition. The explanation of access tokens being valid for 24 hours is especially important and clearly communicated.
It could also help to include a short example of how a token is requested or how an authenticated API call is made, as that would make the documentation more practical for developers using it later.
Overall, the wiki page provides a good introduction to the API access process and documents the important account and token details clearly.