We get a couple of questions every so often, these may help for any clarifications:
1. Is this a plugin that I as a website owner would install and add API credentials for, which would allow customers to customize what they want to see? Or would customers have their own API access credentials that they would need to add in their settings screen?
• API credentials would be from the site owner, not each user.
2. Does the API have an end point which shows a schema that we could use to dynamically keep the list of available elements updated? Or are we hard coding it all?
• There’s no schema available, you’d hardcode the variables that you need to store according to the current version of the API.
3. What purpose does the widget serve? Simply showing different API content in a sidebar on the site, based on the currently logged in user and if no one logged in, show no content at all?
• Exactly, mainly the purpose of this widget it’s to see how you as a developer would interact with an external API.
4. How much flexibility is required for the displaying of the data in the widget and the my account tab? Are we hard coding a layout for them, or building some sort of a templating system where they can use their own html & css to show the API element data?
• Implement the layout however you see fit as per the first clarification (this is a plugin configured on the server, not by each customer). Ideally templates could be replaced from the theme, but that’s not a requirement.
5. So you’re basically wanting me to write a plugin with functions not fully fleshed out? Like a bunch of pseudo code in comments?
• Yeah, it’s so we know your flow, how you approach your code. What things you keep in mind while building it, which functions you use. Not pseudo code, real code, but not fully fleshed out. It doesn’t need to be pixel perfect on the frontend. We won’t put it to run, we’ll review it code wise and standards wise.