An application programming interface (API) is the specification for which software is meant to be used by other software.

learn more… | top users | synonyms

8
votes
3answers
139 views

In REST parlance what is the difference between a resource and a representation?

My understanding of REST that is enables modelling service operations as representation of state and transition from one state to another making use of HTTP. I have always understood resources as ...
18
votes
6answers
2k views

What to call an HTTP API that is not RESTful? [closed]

What would you call an API that is HTTP-based, uses URI to name resources and HTTP verbs (PUT, POST, DELETE, GET...) to manipulate those resources? According to Roy Fielding's complaints it is not ...
0
votes
1answer
54 views

Creating an API for existing products

Lately I've been searching for information about creating API's. The company I work for wants to sell some of our products as stand alone devices. Currently these products work inside enormous ...
1
vote
0answers
23 views

Building back end for iOS/Android app using Django and Heroku

Background: I'm currently building a music streaming app (many requests per second) for a friend and am second-guessing my approach to it. The plan is to have an iOS app and an Android app, though I ...
0
votes
2answers
140 views

What is it exactly that makes programs platform dependent when they're using cross-platform APIs?

I understand that programming languages can either be run in a VM (Java, etc) on every OS that supports the VM natively or can be compiled to machine code (C, etc) for each platform. What I don't ...
3
votes
1answer
629 views

Merge two different API calls into One

I have two different apps in my django project. One is "comment" and an other one is "files". A comment might save some file attached to it. The current way of creating a comment with attachments is ...
2
votes
1answer
37 views

In SemVer 2.0.0, what kind of public API change category is the addition of a new exception?

I am working on an implementation for an existing public API. Now I needed to change the implementation to throw an exception for a failure condition about which previously the API consumer was not ...
3
votes
1answer
430 views

How to bypass Oauth2 authentication when the client and resource owner is the same entity?

We are currently working on using an API provided by Mercado Libre which is a maket place for selling various goods. Their APIs use OAuth 2.0 for authentication. The problem is that OAuth 2.0 as ...
2
votes
3answers
124 views

Correct RESTfull way to refresh a resource

Imagine we have resources like reports. We have a collection because every report contains its own settings to build some data. Every report calculates its values on regular basis but not to often. ...
-4
votes
0answers
31 views

Mobile Application API - where do you get them from? [closed]

Mobile Application API: Where do you get them from? How to tell if they are available for public use or to buy API? Let say, I am looking for a company that provides API so I can play voice ...
1
vote
2answers
39 views

Message vs ErrorMessage API design

I'm desing API for generic task executor that currently supports two calls: Accept task Get task info The (2) provides detailed information about the task with the task status and custom message, ...
5
votes
3answers
14k views

Is it safe to transmit access tokens via HTTP headers?

It's the first RESTful web service and I am concerned about security issues. Is it safe to transmit my access token via HTTP headers? For example: POST /v1/i/resource HTTP/1.1 Content-Type: ...
1
vote
1answer
282 views

Making API calls with celery

I'm designing a system for a client where the requirements are: they upload a JSON file (one object/line) make a call to an API with the JSON object as the payload record the state (success/failure) ...
2
votes
2answers
103 views

Warnings in a REST API as not critical errors

I have a REST API that for some of entpoinds like DELETE, POST or PUT I have some validation rules that can return an error. Now I need a new type of an error like a non-critical error, that it ...
1
vote
1answer
259 views

Manage the persistence of entities on iOS in several places: CoreData on the device, iCloud and on a REST API

For the needs of a project, I would persist the datas contained in Core Data in several places depending on the state of the user. If the user is logged to my API -> Persist the datas on my API. ...
0
votes
1answer
37 views

Splitting API and Implementation among packages/jars

I have a dilemma. How to do better? I have a bunch of API interfaces and their implementations which use some specific frameworks/librarys which I would not like to expose. I cannot make a decision ...
0
votes
0answers
34 views

How to manage Permissions for an api

I have a question about permissions and roles in an application. Let's assume app.get("/users",hasPermission("user:read"),...) and I have a lot of these calls and then a lot of permissions. How do I ...
7
votes
2answers
124 views

How to work with/around an API that does not return errors?

I am currently working on a project which requires data fetching from a 3rd party closed API (over SOAP). Currently I'm in a situation where I have to do argument and data validation inside our ...
3
votes
3answers
93 views

Is it possible to call a function or a script with a REST API?

Let us say that I want to create a workout app and a website, the user enters his workout stats and the app display his stats with graphs percentage and such. This is an example I don't want to ...
7
votes
2answers
124 views

Prevent abuse to REST API endpoint

Question 1 I have a login API endpoint http://127.0.0.1:8080/api/account/login It checks if the phone number has been validated. If not it will call POST http://127.0.0.1:8080/api/account/sendsms ...
0
votes
1answer
77 views

How to design a system that interacts with several competing REST APIs? [closed]

Understandly is a web application that lets people manage the translation of marketing content (such as AdWords campaigns). Currently, people have to use "their own" translators. We're looking to ...
0
votes
1answer
86 views

Accessing data from private API (with Basic Auth credentials) using Angular JS

I have been tasked with connecting an existing Angularjs app to a third party service via API using Basic Auth credentials I got from the third party website. I am not as experienced with Angular and ...
2
votes
0answers
48 views

Best way to build a JSON API coupled with HTML views in a Rails project

I've got a Rails eCommerce project communicating with an iOS app. The iOS app receives JSON data from the Rails back-end, but there's also HTML rendering when a user comes to the project from his ...
5
votes
2answers
331 views

How to prevent multiple form submissions when user reloads the page

I'm currently working on a project which requires that we integration a 3rd party SOAP API to handle a number of basic CRUD type operations. Our current implementation allows us to leveraging the ...
4
votes
1answer
112 views

API Server Client Setup

Suppose you have a setup where there is an API Server and all interaction revolve around the API. There is the admin, public and third party components that interact with the API server. Suppose we ...
0
votes
0answers
29 views

Develop an API within ESB to access a database

I am working with a service provider where I need to get data from their service. The service provider wants to give me access to their database to get the data I need. My question is should I ...
1
vote
1answer
23 views

Rate-Limiting in an OAuth REST API: per token or per consumer?

I am building a REST API and intent to use rate limiting (using the leaky bucket algorithm) as a way to protect against crawling and enumeration. The API will be consumed by a Mobile/Tablet App ...
0
votes
0answers
43 views

Looking for pros/cons on using OWIN vs. a simple hand-rolled token based auth

We are wanting to implement an API to be used internally and externally and add it to our solutions. Some environment notes: We are currently using VS2013, .Net 4.5, EF5, SQL2008, MVC4, C#, and ...
0
votes
1answer
41 views

Keeping track of data deleted upstream

I'm building an application that queries several APIs and duplicates some of the data in a downstream, centralized database to make it easier to perform some processing on it. My application will only ...
-1
votes
1answer
122 views

Code structure of third party framework [closed]

Is an API always returning 200 OK, an issue?
1
vote
2answers
371 views

Questions to ask a 3rd party API provider [closed]

I'm due to meet with a developer/sales person from a new 3rd party resource we're about to start using. The main topic I'll be interested in, is their API as I will be the developer making use of it ...
1
vote
1answer
62 views

My web app uses a number of photo hosting APIs. What would be an effective database design to store their limitations?

For the sake of an example, let's say I'm using Picasa, Flickr and 500px APIs, and that each of the services has limitations on these simplified parameters: overall account space individual file ...
7
votes
3answers
188 views

Version control on standalone (in-house) libraries?

Problem Statement At our company, we have various application projects that we work on and then we also have libraries that those projects need to utilize. I feel the need (based on some similar ...
1
vote
1answer
32 views

Which layer should convert timezones given querying on aggregate tables?

I'm running a Django application service with an API that feeds to a javascript frontend. The data is specifically for charts and graphs, so the data that is returned is a fairly large json with every ...
19
votes
3answers
6k views

REST API security Stored token vs JWT vs OAuth

I am still trying to find the best security solution for protecting REST API, because the amount of mobile applications and API is increasing every day. I have tried different ways of ...
2
votes
2answers
294 views

Modeling a multi-channel communication device in C#

Background We (my coworkers and I) are architecting a high level C# API to interact with a hardware device's native Windows DLL. First I will discuss the hardware-architecture, then get to the ...
0
votes
1answer
37 views

Bound Variadic Arguments: Bitmask vs Array

Intro The following assumes C# as a reference language, or any other statically typed language. This is not a question specific to Unity's API, but it is used as an example. In Unity's API, most ...
0
votes
3answers
97 views

Should REST APIs contain the ability to dispatch email?

When building a service that uses both a back-end REST API, and (a) front-end application(s), is it proper to build into that API the ability to dispatch email? Take Twitter for example; for those ...
5
votes
4answers
381 views

Avoiding hangs when calling a native API

Background We have a piece of programmable hardware here at work that we integrate into almost all of our systems. This piece of hardware came with a native Windows DLL (for which we do not have the ...
4
votes
1answer
138 views

A manual and automated CSV file upload solution for a website

Problem I run a website which has a requirement for a new feature - to enable users to upload CSV files into the website. The users will only ever need to upload 1 CSV file at a time, and only 1 or 2 ...
0
votes
0answers
16 views

different teams,applications, APIs for VM inventory

I have built small python script and module based on pyVmomi python version of VMWare API to take status check of a few hundred Linux VMs on VMware. It makes text files we can use with unix tools for ...
-2
votes
2answers
174 views

Angular JS vs Modern MVC frameworks

I might be wrong for some things here, but here is what I recently though about. Modern frameworks MVC such as ASP.NET MVC 5, CakePHP, Java Spring etc. has their logic clearly separated into Models ...
28
votes
2answers
11k views

Trailing slash in RESTful API

I have been having a debate about what to do with a trailing slash in a RESTful API. Lets say I have a resource called dogs and subordinate resources for individual dogs. We can therefore do the ...
1
vote
1answer
160 views

Which is better to call: API or Database?

I'm building a web app that hits up some APIs to get JSON dumps of data. I'm running across a problem. I can either grab all the data, dump it into a DB, then pull it from the DB as needed. OR I can ...
4
votes
5answers
3k views

Domain Lookup API

I am looking to incorporate a domain name lookup facility in my website to make sure if a domain is available or not. The only api I could find on the net is ...
2
votes
1answer
57 views

Can a API backed by a RDMS be refactored into Micro services?

Working on an API... Consider an example database like the following for some enterprise-facing application: +-------------------------------+ | tables | ...
1
vote
2answers
2k views

API always returns JSONObject or JSONArray Best practices

I'm making an API that will return data in JSON. I also wanted on client side to make an utility class to call this API. Something like : JSONObject sendGetRequest(Url url); JSONObject ...
1
vote
2answers
1k views

How do I read API documentation? [closed]

I've been trying to read through the RoR API to try to learn things that the tutorial missed, and I haven't been able to follow it at all. The only time I've read documentation was when I needed to ...
6
votes
5answers
1k views

PHP - Internal APIs/Libraries - What makes sense?

I've been having a discussion lately with some colleagues about the best way to approach a new project, and thought it'd be interesting to get some external thoughts thrown into the mix. Basically, ...
3
votes
2answers
110 views

Is an attempt to create a duplicate resource, e.g. a user, worthy of throwing an Exception?

Say I have an REST API for creating users in an application. The request goes to a controller, which marshals the request data into a domain object, and passes it to a service to create a user. Now, ...