We need a wiki page that documents how we got api key to Västtrafik #821

Closed
opened 2026-05-07 13:22:02 +00:00 by a22erigr · 5 comments
Collaborator

Description

During the customer meeting the customer suggested that we should document how we got the apikey for Västtrafik.

What should be done

  • When we revived the key did we have any restrictions on what it can be used for.
  • how did we get it.
  • How long is the key valid.
## Description During the customer meeting the customer suggested that we should document how we got the apikey for Västtrafik. ## What should be done + When we revived the key did we have any restrictions on what it can be used for. + how did we get it. + How long is the key valid.
Collaborator

I'm guessing I'm writing this?

I'm guessing I'm writing this?
Collaborator

@a24vinla wrote in #821 (comment):

I'm guessing I'm writing this?

That would be best yes!

@a24vinla wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/821#issuecomment-8766: > I'm guessing I'm writing this? That would be best yes!
Author
Collaborator

@a24vinla wrote in #821 (comment):

I'm guessing I'm writing this?

Yes

@a24vinla wrote in https://git.webug.se/Andras/BoundlessFlowCampus2K/issues/821#issuecomment-8766: > I'm guessing I'm writing this? Yes
Collaborator

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

[Link to wiki page](https://git.webug.se/Andras/BoundlessFlowCampus2K/wiki/V%C3%A4sttrafik-API) 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
Collaborator

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.

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.
Sign in to join this conversation.
No milestone
No project
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
Andras/BoundlessFlowCampus2K#821
No description provided.