Questions tagged [api]
API stands for Application Programming Interface and refers to the specification of how to integrate a system with others. Questions with this tag refer to the UX of either API design or API documentation.
16
questions
0
votes
1
answer
26
views
How is payment api gateway interfaced if I have 2 or more regions using different gateways?
I am currently designing an app for 2 different regions, 1 in US and 1 in Taiwan.
For US, I am using Stripe as the payment gateway api,
For Taiwan I am using Newebpay as Stripe is not available.
These ...
- 1
1
vote
2
answers
83
views
Show filters in error condition of table
I have a mockup, shown below, presenting an error state if a data table doesn't load for some reason such as an API failure.
A developer asked whether the filter should even be shown if the content ...
- 299
2
votes
1
answer
104
views
What are some approaches for In-app UX for API documentation?
I’m working on this platform-as-a-service product for developers. We have a web GUI and an API, and I’m trying to think of ways to bring these closer together such that the developers can interact ...
- 131
2
votes
2
answers
1k
views
How to show errors in nested JSON in a REST API?
How would you recommend as the best approach / UX for sharing with a customer the REST API errors in their nested JSON body? Say for example they are to send an object with 30 fields, but they only ...
- 473
1
vote
1
answer
101
views
Dropdowns/Select with changing list of items
I have "dropdowns" and "select inputs" that are fed from a remote endpoint. The list of items coming from the endpoint changes over time, so it's possible that an option selected some time ago is no ...
- 111
2
votes
4
answers
3k
views
Should someone be able to log out without an internet connection?
Facebook and other apps allow you to log out without an active internet connection. We have to make the decision to allow this or not, but I think that you should ask for an internet connection to log ...
- 23
3
votes
2
answers
139
views
Block screen when refreshing data
I have a web app with a grid with some data. The grid refresh every 1 minute, the problem is that the API I am calling takes more or less 2 seconds to retrieve the information. To avoid the user make ...
- 133
1
vote
1
answer
60
views
For a closed off API, is not more friendly to have only a 'secret' - no 'username'?
Quite a few API's have something like a 'username' and a 'secret'.
Is there anything against the decission to just work with a (generated) secret?
Of course the secret should be long enough - GUID ...
- 995
1
vote
2
answers
82
views
Approach for researching developers using SDKs and APIs
We do enteprise software and we have a couple of projects coming up where we're building Software Development Kits and APIs that will be used by developers in our customers' IT departments.
When it ...
- 73
6
votes
2
answers
642
views
How would you handle pluralization of irregular nouns such as "person"?
If you were using an API where every resource was pluralized, and you came across a 'person' endpoint, would you prefer and/or expect /persons or /people?
I can see benefits to both and was ...
- 171
0
votes
1
answer
116
views
How to work with web designers pragmatically on my stateless browser app?
These days, lots of stuff is being done on the client. This includes full page rendering, data fetching, and much more. Right now, I am developing an API and also working on the client-side app which ...
- 111
5
votes
2
answers
269
views
Organizing all the different API key types without going mad
I'm designing a dashboard for a web app that also allows API access. I got stuck while designing the API keys screen (used to generate .. well, API Keys).
See, there are 2 different states for API ...
- 155
2
votes
3
answers
2k
views
Which software do you use for facial expression analysis?
Dear incredible community, I am once again in need of your help.
Summary: Looking for a tool to analyze participant's webcam feed to produce a report of facial expressions - it does not have to be ...
3
votes
7
answers
22k
views
What should replace a space in a api url? [closed]
I am creating an API, where we can make reference to the users with their firstname and lastname. Since I can't use space, what is the best way to separate the firstname and lastname in the url?
I ...
- 151
2
votes
2
answers
782
views
How to differentiate between vertical and horizontal splitting of a view
I'm working on the programming interface (public functions) to an API for graphical UI layout. The API does everything in terms of frame objects - simple rectangles in which stuff can be displayed.
I ...
- 346
14
votes
5
answers
2k
views
What methods do you use to test the usability of an API?
Testing the usability of a programming interface poses a lot of challenges. It has a very different feel than testing a graphical interaction. The user can do almost anything at any time, as opposed ...
- 6,274