Timeline for API design: how to minimize client support?
Current License: CC BY-SA 4.0
Post Revisions
15 events
| when toggle format | what | by | license | comment | |
|---|---|---|---|---|---|
| Dec 8, 2021 at 19:09 | vote | accept | Hans | ||
| Dec 2, 2021 at 13:36 | answer | added | Robert Bräutigam | timeline score: 2 | |
| Dec 2, 2021 at 13:11 | answer | added | JonasH | timeline score: 5 | |
| Dec 1, 2021 at 16:32 | comment | added | Filip Milovanović | I meant it's a business problem between you/your company and any other parties involved, in the sense that it's not necessarily something that the software is going to solve (except, perhaps, partially), but something that depends on your contracts and ability to negotiate with clients (about what the project will look like, how it'll be managed, who'll confirm to whom, what kind and what scope of support they can expect afterwards, etc.), and business and operational arrangements/capabilities to put all that in practice. | |
| Dec 1, 2021 at 15:55 | comment | added | JimmyJames | It seems to me that your answer is somewhere in here: "request bodies were not documented in every detail, responses would contain cryptic data sets, custom features or resource properties were needed etc." | |
| Dec 1, 2021 at 15:35 | comment | added | Hans | I think my client and the dealers have a history of working together, and the API is by their request. Seems to be less work than having all the dealers switch to the same software. | |
| Dec 1, 2021 at 14:48 | comment | added | Doc Brown | So the car dealers need to invest a lot of money to make their software vendors adapt their software to your API? Why should they? Is there a legal obligation for them? Besides that, I think you should not talk to the car dealers, you should talk to their software vendors instead. | |
| Dec 1, 2021 at 14:41 | comment | added | Hans | You mean it's a business problem because they have to set up a ticketing solution and hire enough people to respond to support requests? | |
| Dec 1, 2021 at 14:36 | history | edited | Hans | CC BY-SA 4.0 |
added 36 characters in body; edited title
|
| Dec 1, 2021 at 14:36 | comment | added | Filip Milovanović | Well, while there might be a way to design away some of that, ultimately, that is less of an API design problem, and more of a business problem. | |
| Dec 1, 2021 at 14:30 | comment | added | Hans | I mean "support" as in number of opened tickets or, even worse, incoming emails/phone calls. @FilipMilovanović | |
| Dec 1, 2021 at 14:29 | history | edited | Hans | CC BY-SA 4.0 |
added 36 characters in body; edited title
|
| Dec 1, 2021 at 14:27 | comment | added | Vincent Savard | Can you clarify what you mean by communication in this context? Do you mean the need to have conversations between the maintainers of the API with the people who will make requests to it? Do you mean the number of HTTP requests sent to your API? | |
| Dec 1, 2021 at 14:25 | comment | added | Filip Milovanović | Will their clients conform to your API? If so, design an API that doesn't need a lot of back and forth (transmit larger DTOs rather than small "entities"). <-- EDIT: I've written this assuming you meant network communication - but, did you mean communication between people instead (as in, about project organization & logistics)? | |
| Dec 1, 2021 at 14:17 | history | asked | Hans | CC BY-SA 4.0 |