API stands for Application Programming Interface. A program's API defines the proper way for a developer to request services from that program.
1
vote
1answer
44 views
Orchestrate.io Client API Design
I've written a Python client for a new NoSQL database as a service product called Orchestrate.io. The client is very straightforward and minimal. It uses the requests library, making the underlying ...
4
votes
1answer
70 views
PHP wrapper around an API - best practices
Here's a PHP wrapper around a public OAuth2 REST API. I would love to hear your thoughts and comments. Testing was a bit frustrating since I tried for my first time. Not sure if I have done the ...
2
votes
1answer
41 views
Backend interface VS hard contract
Here is an API for using a warehouse:
public static class WarehouseClient
{
event Action<IWarehouse> WarehouseCreated;
}
public interface IWarehouse
{
event ...
7
votes
2answers
79 views
Java API without exposing implementation details
I am creating an API for consumption by other developers to interface with an internal framework. My goal is to be able to have the developers type something like:
profile.setPreference(new ...
2
votes
0answers
76 views
XLSX writer implementation
We have multiple scripts which write into XLSX with the same format, into a different format or slide variation. I am trying to write an API which saves time for other programs, but I need input on ...
9
votes
4answers
182 views
XmlCmdBuilder - doing away with inline xml
I have to work with a 3rd-party API that allows me to define and execute "commands", using XML. Since I don't like seeing mixed abstraction levels, I managed to remove all the inline XML / string ...
2
votes
1answer
54 views
Generic java configuration class with type safety
In the first code snippet I am creating a generic class to hold configuration details. I am currently using it as a way to pass run time configuration options to plugins in a generic manner. The ...
5
votes
2answers
88 views
Is the public interface easy to use and the documentation understandable? Are the unit tests well-written?
I have a year or so of experience in developing in Java. I submitted the solution for this task, but never got the feedback that was promised. Since I still would like to get a feedback on my ...
4
votes
2answers
171 views
My API Keygen: Is it secure?
Below is an api key gen script for a cryptocurrency trading platform i am building.
first it checks to see if a key exists in the db for the user id. if it does exist it displays the key. if it ...
0
votes
1answer
39 views
Evaluating a hashing function used to create secure API key
What are your thoughts on the following code? is it secure enough?
Note: $password is used to represent the secret, which would essentially be a SHA512 hash of
username . password . ...
1
vote
1answer
35 views
Working with APIs in javascript
I'm not new to programming, but I am new to working with javascript (beyond copy/paste and simple edits).
I am building a one-page JS app similar to redditinvestigator.com, and my goal is for it to ...
3
votes
2answers
75 views
Structure of API wrapper
I'm building an API wrapper for a bookkeeping SOAP API.
I have some questions regarding bast practice for structure of the wrapper and for error handling.
For now i've structured it like this:
...
4
votes
1answer
109 views
In-memory data cache architecture for data transfer
I am writing a cron job to manipulate and transfer remote data.
I need to cache data from a table, process it, merge with previous table, iterate the process, and eventually send the result data to ...
2
votes
1answer
65 views
Rails 4.0 api_key implementation
I'll be brief and let the code speak for itself. I need some very harsh, honest, blunt feedback on this code. I am new to Rails - don't hold back.
I have a concept of the user having many API keys, ...
3
votes
2answers
151 views
Multiple serial URL requests in Objective-C / iOS
I want to check the existence of various API endpoints by doing serial URL request. If the first one fails, I want to try the second one, if the second fails I want to try the third one, etc.
Here is ...
2
votes
1answer
60 views
RESTfulPHP / controller / structure
Allow for stuff like:
API/ExampleObjects
API/ExampleObjects/SOME_INTEGER_ID/Children
...
with children knowing their owners (aka parents).
Full repo here
Please be brutally honest if something ...
1
vote
1answer
139 views
Node.js DynamoDB callback
I am writing an API which gets results from a DynamoDB table and puts the JSON back into the browser.
The code below works and returns the desired results. However, after reading about async and ...
3
votes
1answer
94 views
Python Leafly API
Just wondering what I did bad/could have done better. It's a simple script for pulling information from Leafly about cannabis strains. I've also added in a function to search. I am fairly new to ...
1
vote
1answer
241 views
Python API client design and best practices
I'm creating a Python API client, after thinking and checking some open source Python clients I created this class, and I'm looking for any feedback (design, best practices...), this is an example URL ...
6
votes
2answers
299 views
WebAPI - Return models vs entity and partial class with meta data
Wanted some opinions on something I have been working with, I've tried a few ways of structuring the way I retrieve and return data to my WebAPI, and I'm pretty happy with what I have so far, but I ...
2
votes
0answers
75 views
node.js Review Core class of a Javascript framework for SPA's
A few years ago I started building a tiny (~300 SLOC) JavaScript framework for scalable and maintainable Single-Page-Applications written in CoffeeScript:
https://github.com/flosse/scaleApp and ...
1
vote
1answer
176 views
Code review on an API wrapper in C# wanted
I'm looking for remarks on pretty much anything. This has been my first project that's meant for use by others and I'd like to have it as clean as possible. I will post the main source code here but ...
9
votes
2answers
188 views
Date Format provider
I am facing a issue with an API to handle dates in Java. I am not a very experienced programmer and my English is very bad.
Problem
I'm working in a large project with many subsystems, and I want to ...
0
votes
2answers
52 views
the right way to write javascript client's method for channel subscribing
I am writing an open-source application for real-time messaging in web. In my application clients from browser can subscribe on channels. But every channel belongs to a certain namespace which ...
1
vote
1answer
296 views
C# Fluent API idea
I've been toying with an idea for fluent API for my library. Basically, what you need to construct with my library is a tree, which might have nodes of different types on different levels. The problem ...
1
vote
0answers
22 views
Providing a Protected Global API to Third-Party Widgets
I am creating a Web Application which provides a global Javascript-based API (in the variable System) and it includes methods that will be provided by frameworks (stored in System.Frameworks[name]).
...
0
votes
0answers
65 views
How can I refactor Api::SessionsController?
I have session controller for mobile devices. I would like to refactor it a little, for example because my session controller is sub class of Devise::SessionsController I had to duplicate error ...
0
votes
1answer
87 views
How should I refactor my image uploader script?
I come from a C background and need help refactoring the following imgur image uploader script I wrote.
It checks if a token_file with access_token and refresh_token exists. If not, it instructs the ...
0
votes
0answers
222 views
Script is extremely slow to display results
I have this PHP script below that requests data from the Twitter API and then displays it on the page according to the information that I have in my local database because I stored twitter usernames ...
3
votes
2answers
129 views
Singly-linked List Library
This is sort of a follow-up to a post I created about 10 days ago, but I have completed the implementation: Designing function prototypes for a singly-linked list API in C.
As I began to work on the ...
2
votes
1answer
121 views
Designing function prototypes for a singly-linked list API in C
I am in the process of rewriting in C all the data structures that I learned about a few years ago to increase my understanding of data structures and the C language. The first one I'm doing is ...
0
votes
2answers
158 views
How is this for an API structure
I have just written an API framework which I am hoping to implement into one of my large sites very soon. However, before I do so, I want to be sure that the script is well written and there are no ...
2
votes
1answer
88 views
Refactor code for API wrapper
I am looking for ways to improve my API wrapper for Pocket. So far, my code is quite compact and nice (I think), but I feel like there must be a better way to do this.
This is the part where I think ...
1
vote
1answer
64 views
Designing a RESTful API for a 3D Printer [on hold]
I'm implementing a REST API to manage a 3D printer, it will add a layer to the system so instead of sending GCode commands (the language the controller understands) directly to the controller (an ...
2
votes
0answers
61 views
Stream-chaining
My goal is to have a reusable pattern for doing concurrent stream-processing in Go.
The stream has to be closable from any node.
Errors should cleanly close the stream and forward the error to the ...
2
votes
1answer
612 views
REST-ish API Account Controller - how's it look?
I still have to implement api keys for client auth, but so far this is what I have for users. This was built using WebAPI and SimpleMembership with Forms Auth:
Is Authenticated:
public class ...
1
vote
0answers
65 views
Key Press Handler
I have made a class to import into my projects to more easily handle the state of the keyboard so I can use stuff like:
if(Keys.returnKey(37)){
As opposed to setting up key listeners.
Please give ...
2
votes
2answers
177 views
Is it ok to use PHP's strpos and substr altogether in one statement?
I am using PHP to build a REST API. I want to receive requests from the URL in the following format:
http://mydomain.com/api/format/method?app_id=value&call=encrypted_request
So, I have modified ...
3
votes
1answer
254 views
how can i make this small jQuery serializeobject util any better
I have this little utility/helper which serializes a form into a javaScript object
$.fn.serializeObject = function(fn) {
var o = {},
a = ...
6
votes
1answer
260 views
Doubts about the quality of an API designed for use with minimal effort
This is going to be long, and I do hope it is going to make some kind of sense; I apologize if it doesn't. I'll try to provide exactly the amount of context that is necessary to understand the ...
2
votes
0answers
96 views
jQuery plugin boilerplate jquib - critics please
Inspired by jqueryboilerplate.com I extended their boilerplate to fit my needs. Comming from the PHP development I wanted to have good starting point for writing jQuery plugins with a defined ...
4
votes
1answer
1k views
Backbone.js Dependency Injection API Design
I'm writing a dependency injection plugin for the Backbone javascript framework, and I'm not sure what the API for constructor argument injection should look like.
Just for reference, Backbone ...
2
votes
1answer
205 views
How can this code, especially the binary search, become cleaner and less error-prone?
How could this code become cleaner? I think that the way I handle the interfaces and binary search could be improved. I am trying to understand how to structure such a code (and usage of APIs) in a ...
0
votes
1answer
105 views
(revised) Python script to access genealogy api for list of users and attributes
The problem the code is solving
This is a script to access the stackexchange api
for the genealogy site
and create a list of user dictionaries.
Ie each user dictionary contains the info about that ...
0
votes
1answer
126 views
Accessing a REST API with PHP
I'm currently using a scientific information management system that employs a RESTful API. I've never used this API with PHP, and I had a hard time finding best practice examples online. After some ...
1
vote
1answer
199 views
Is there a better way to loop through records and call an api?
I have a CakePHP function here that gets info for a twitter screen_name from the twitter api and writes it to a mysql db. I'm just looking for feedback about other ways to accomplish this that might ...
2
votes
1answer
174 views
Creating JavaScript API for first time; request review
I am creating a commercial API for the first time for responsive webpages/web applications (mobile devices).
I am new and, sadly, working alone as well as new to Javascript (long complicated story).
...
1
vote
2answers
331 views
PHP api design - anything done badly?
I have created an api in php and I was hoping some clever individuals would mind reviewing it to see what I could do better. I have commented it heavily to explain my reasoning. please feel free to ...
2
votes
1answer
92 views
Javascript API - Library Loader
What my API does and Why - A Brief Explanation
I have written a Javascript API that loads and houses libraries of code to do all sorts of things on websites.
Effectively, this is (will be) the base ...
1
vote
0answers
156 views
Very simple async MixpanelAPI
I would love to hear feedback on my first open source project (a very simple async API for Mixpanel).
It implements a REST client for this REST HTTP API.
Review requested on the following aspects:
...
