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

learn more… | top users | synonyms

-3
votes
0answers
25 views

Making a Call to an API service to Test Service is Up

I would like to build a call to the CallCredit (used by, amongst others, UK Fin Services organizations to validate ID's) service to only test the service is up and running and responsive to 'real' ...
1
vote
1answer
39 views

How is approval done in cors via preflight request?

As far as I have known in CORS, browser sends preflight with OPTIONS request to the server to gain approval for the real subsequent GET/POST request. Now, HTTP is sessionless. Is the custom header THE ...
2
votes
1answer
84 views

REST API design: distinction between searching and getting all instances of a resource

At the moment, my (pretty standard) REST interface looks like this: POST /foo # creates a new foo PUT /foo/{id} # updates a specific foo GET /foo/{id} # returns a specific foo GET /...
0
votes
0answers
17 views

Developing Python Scripting API using Petrel Ocean SDK (C#/.NET)

I use a commercial software called Petrel. Petrel has a software development kit (SDK) that allows the user to develop plugins in C#/.NET via the Ocean core API. At our offices, we have installed a ...
0
votes
1answer
50 views

designing php POST interface to mobile app

Currently I am working on php application, to create interface that will receive POST data from mobile app, and process them into shared database. To do things right at a first time, I was searching ...
-3
votes
0answers
78 views

What choices do I have in implementing an in house API? [closed]

I have been asked to help implement an in house API and desktop app for a partner company. They would like an on site Server (cloud is out of the question for them for now) and to use existing ...
7
votes
1answer
212 views

By the book REST vs Too Many Requests

From Roy Fielding's comment on his own article decrying fake REST apis: A truly RESTful API looks like hypertext. Every addressable unit of information carries an address, either explicitly (e.g....
0
votes
0answers
23 views

Javascript : Handling multiple API Requests (Adobe Analytics)

I have a requirement to build a enterprise dashboard where data from various digital assests (around 20 primary websites, mobile apps) of our company can be presented. This data is already stored in ...
-3
votes
1answer
44 views

Web framework to consume external API [closed]

I'm currently joining a project in which there's a core REST API already developed which is used for a mobile app. The next step will be to build a web app which should also consume the API. My doubt ...
0
votes
1answer
27 views

A WebSocket API, reply message

I am writing a Web application for copying files between servers. I decided to write a WebSocket server which will receive and send relevant messages (that is communicate with a browser), start and ...
3
votes
3answers
126 views

What is the advantage of API clients

At my new job I am working on a basic existing CRUD web application in MVC + with an angular front-end. The MVC API has a swagger spec and it's used to generate an API client with auto rest. That API ...
1
vote
4answers
217 views

MVC and RESTful API service

MVC is pretty straightforward. There is a Model, a Controller and a View. When we create a website, it all come together as 'client sends REST keyword request to server -> the server matches the ...
6
votes
5answers
329 views

Should I treat a worker as another 'user' in my system?

Basically I am designing a web-enabled application that should have an API in the middle. I found this question on Stack Overflow, which unfortunately has no answers. Let's say there is a system, ...
0
votes
0answers
22 views

External User ID to Internal User ID

There is an internal API, REST client over DB, all of which methods require User ID as parameter. User ID is an integer value - numeric PK in User table. Also there is an public API, that is like a ...
0
votes
0answers
38 views

Abstracting remote API efficiently in Python

I have to replace SQLAlchemy "table" (declarative) class with mostly functionally equivalent wrapper, which will use API of another microservice. All the usages can be edited, so there is no need to ...
1
vote
3answers
165 views

What's code that's not a part of API called? [closed]

In a library with many code, some of them being the API which user would use to interact with the library, what should I call the rest of the code which is not part of the API directly? In other ...
0
votes
1answer
104 views

What is the best way to publish a REST API so that other people can see and improve/add new methods on it?

I have a requirement to (re)design an existing REST API which is written in Django REST. One of the main requirements is allowing third parties, approved by us, extending of our API. The API is a ...
1
vote
2answers
93 views

What API design makes the most sense for changing a user's password?

Consider a web page where a user changes his password after clicking on an emailed password reset link. The page will be implemented against an API using ajax, rather than as an ordinary form ...
1
vote
3answers
100 views

REST API - proper way to handle non-CRUD items with REST

So, there are many times where I have to do things with my REST API that seem outside the boundaries of REST. In this particular instance I need to have an endpoint that checks whether a member is ...
-5
votes
1answer
101 views

How to detect someone tweets using twitter API?

I am learning API. I now want to write a program to send an email once some twitter users tweet. I have found there is an API call (user_timeline) which can get the tweets from an user. So my idea ...
-1
votes
2answers
60 views

what is the utility to a REST API for SIP trunk's?

Why does Twilio offer: Trunking REST API docs - Provision, configure, and modify SIP Trunks and phone numbers with the REST API. What are the top usages for this API? I appreciate that the ...
1
vote
1answer
45 views

Specialized API endpoints or multiple calls to generic resources?

This problem came up while designing the API for a SPA web application, which communicates with the server via AJAX. On one page the user, who is creating a list of people to invite to an event, has ...
2
votes
4answers
120 views

Best practice for RESTful API calls with variations

How do I name API endpoints that serve the same entity in different ways and still adhere to the RESTful API guidelines? Let's consider I'd like to get a customer with ALL his details. I just ...
1
vote
2answers
159 views

Structure of RESTful Service with Java Spring for Beginner

I am relatively new in terms of Java web development skills. I have a project that I think would make a good candidate for a RESTful service from what little I understand about APIs. I'm trying to get ...
0
votes
1answer
98 views

How to structure a REST API response for a Flux/Redux frontend?

I have a question about how to structure a response where I return objects related to other objects (one-to-many/many-to-one), and to tell me if the way I've structured my endpoints are wrong or not, ...
0
votes
0answers
18 views

business component which can be consumed by .net and java

I want to develop a business component which does basic operations, Create/Read/Update and persists information to some embedded database (Sqlite/Sql CE). This will consumed by web applications which ...
2
votes
0answers
22 views

Storing OAuth2 data in Mongo?

Our system has users but we want to perhaps allow some users to be able to use our API service. I'm looking at using OAuth2 for authorization. As it's going to be (trusted) machine-to-machine access I ...
4
votes
2answers
125 views

Is it smart to use an API on the same server as your web application

Im new to RESTful API's and would like to find some info out. Currently we run a daily digest of eHealth material for the public to read and get up to date content regarding that topic. Which is ...
3
votes
2answers
165 views

How to represent object references in JSON?

I am trying to figure out what's the best approach when dealing with object references in a JSON to be sent to my server for deserialization. To clarify, what I mean is how to refer to data contained ...
0
votes
1answer
86 views

Backend as a service or deploying my own backend

I currently have a web application running with my own backend, but maintaining it is becoming a bit painful so I was considering the option of using an existing BaaS (Firebase). The main problems I ...
1
vote
2answers
186 views

API Design: Should I use strings or an enum for dictionary keys

I am working on an API in C#. I am trying to think about the simplest way to expose my API for consumers of it. In particular, I have a class in my exposed data model that has a dictionary property. ...
0
votes
0answers
16 views

Using JWT over Oauth2.0

I am creating an API that will communicate with a ReactJS app. I am in two minds whether to go through with the implementation of OAuth2.0. The question is why should I use OAuth2.0 implicit grant ...
1
vote
0answers
58 views

Two classes which are supposed to be the same, but differ in lists

I am using a 3rd party API which yields JSON which has two ways of loading data - as a list of items, or as a singular item. The problem is that a given item in the list has different properties than ...
-1
votes
1answer
141 views

Using sessions with Jersey in a REST API

I am starting to develop a REST API with Jersey to retrieve a schedule for a given sport tournament. The client sends a JSON containing a tournament with its different categories, domain, definitions ...
0
votes
1answer
46 views

Building an API with one central connection object to an external device

I want to build an API (Java) that heavily relies on a connection object to a data server that manages a connection to a real device. All i have is a DeviceConnection object. Currently i have a big ...
4
votes
2answers
288 views

Is it bad practice to use hyphens in JSON keys?

I see a lot of questions revolving around accessing JSON keys that use hyphens (kebab-case), but now I find myself wondering should I just stick to camelCase or snake_case in my keys. I know hyphens ...
0
votes
1answer
62 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
57 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 ...
8
votes
3answers
188 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 ...
2
votes
1answer
43 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 ...
2
votes
3answers
136 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. ...
1
vote
2answers
40 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, ...
0
votes
1answer
57 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
35 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
126 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
103 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
180 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 ...
2
votes
0answers
56 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 ...
0
votes
0answers
32 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 ...
0
votes
0answers
58 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 asp....