Cross-refference Greenfield API view in the Legacy API view

[pavlenex]

Context:

When started, BTCPay Server had a BitPay-compatible API, which to this day still works. However, due to various limitation of that API, and BTCPay growing as a stack, we introduced Greenfield API which allows pretty much to run BTCPay headlessly.

The difference between the two API's is that Greenfield API is account based, where as, BitPay compatible (legacy) API is store based. This is currently reflected in BTCPay's UI, where Store Settings > Access Tokens showcases Legacy (BitPay compatible API), and Account > Manage > API Keys is for Greenfield.

Problem:

While we mention (link to) the legacy api on the Account > Manage > API Keys, we do not do the same on the Legacy API page in Store Settings > Access Tokens, which often leads people using Greenfield to enter legacy API keys and face problems.

Proposed solution:

I think besides simple linking to the Account Manage API Keys page, we may also want to add a bit of context so developers building on top of BTCPay don't face this barriers from the get go.

"On this page  you can manage Legacy (BitPay compatible) API keys, which are store-based. For the new Greenfield API, please generate your API keys [here]."

Screen.Recording.2023-12-20.at.11.52.12.mov

Before doing a PR, it would be good if we can first discuss the proposed copy and see if it needs to be ironed out. And how specifically we want to add this text according to our style guidelines cc @dstrukt

[lukeist]

While we mention (link to) the legacy api on the Account > Manage > API Keys, we do not do the same on the Legacy API page in Store Settings > Access Tokens, which often leads people using Greenfield to enter legacy API keys and face problems.

I'm experiencing the same issue.

I've been struggling to use the legacy API instead of the Greenfield API. I kept wondering why it wasn't working. The Greenfield API documentation doesn't mention the need to go to Account > Manage > API keys. I initially thought the legacy API was the same as the Greenfield API until I came across this.

Before doing a PR, it would be good if we can first discuss the proposed copy and see if it needs to be ironed out. And how specifically we want to add this text according to our style guidelines cc @dstrukt

I want to help with this issue. Who should I talk to about it??

[pavlenex]

We can discuss possible improvements here @hiluan.

Greenfield API documentation doesn't mention the need to go to Account > Manage > API keys

This is problematic and should be addressed imo. Also related #5572

Would be at least useful to note all of this struggles you're facing, and then let's figure out how to improve that experience.

[lukeist]

It would be great to have a direct link or button under Store Settings > Access Tokens for creating a Greenfield API Key, like "For Greenfield API Key, click here." Alternatively, a button like "Generate Greenfield API keys" directly in that section could work.

If a dedicated button isn't possible, please guide users on how to generate Greenfield API keys by adding a clear reference in the Greenfield API documentation, such as 'Generate a Greenfield API Key: go to Account > Manage > API keys.'

I finally got the right API key today from "Account > Manage > API keys," and it's working well. However, to improve user experience, in the Greenfield doc, it would be helpful to include sample codes for different languages, not just responses. For example:

https://finnhub.io/docs/api/company-basic-financials

https://stripe.com/docs/upgrades/manage-payment-methods

[lukeist]

I made a small change by adding this:

Let me know what you think. Thanks!

[Kukks]

fixed in #5635