Web API endpoints for the space [DMS integration]

Hackerspace Software Development
1

This thread is in reference/response to:
https://talk.dallasmakerspace.org/t/web-api-endpoints-for-the-space-ideas

Basically a place to house discussions about:

  • which ideas already exists at the DMS,
  • what endpoints can exist at the DMS,
  • what endpoints will exist at the DMS in the near future,
  • what endpoints should not exist at the DMS
  • anything that is relevant to both the DMS and a general makerspace web API specification.

The structure of this thread will not be as cookie cutter or strict as the original ideas thread.

2

Here is a link Stan provided about what already exists at the space:

https://dallasmakerspace.org/wiki/RFID_Member_Info_Portal

I’m sure there are more, if you know of any, please post!

3

So just off the top of my head for the current state of software at the space and API endpoints we use:

4

Ok. Do you know of any wiki that describes the endpoints?

For example I know that membership count is an endpoint that exists. I’m looking for a document that might describe the URL.

If it doesn’t exist, then I can start one.

5

Which one? I provided several.

6

I’m looking for one document that describes endpoints that:

  • aren’t defined in the discourse API specs,
  • aren’t defined in the helpdesk API specs
  • aren’t defined in the wordpress API specs
  • describes functionality that is( or should be) conceptually isolated from the inner workings of Helpdesk, Wordpress, Discourse.

We can focus on my example of number of members.
Another space may choose not to use discourse, helpdesk, or WP, but may still want to provide an endpoint for reporting membership counts.

  • This count shouldn’t be provided by discourse API
  • This count shouldn’t be provided by helpdesk API
  • This count shouldn’t be provided by wordpress
  • This count should be provided by x

I’m looking for documentation/wiki on x, If it exists.

7

Ok thank you. That greatly narrows the scope from a “Monster” to “Piece of Cake” . Mind you I’m a certified scrum master and battle hardened professional coder. When asking questions one shall be specific to get specific answers,

Now, said api of https://total.members.api.dms.local/does not exist nor has there been a requirement stated prior. At best one needs to connect to the active directory servers and query for total active accounts, at worst get with an admin on @Team_infrastructure to setup an api key and access to http://talk.dallasmakerspace.org/admin/users.json

IMHO, the quickest way to get one stood up is setup a python-eve/flask application and create a controller blueprint that imports pyad. Route could be /users/:name returns user, /users/ returns an array of all users with a status parameter for active or deactive accounts.

Process for testing and deploying:

  • Need an onsite testing environment? Fill out Vintage Computer Community Grid Signup to get a docker container on the compute cluster at the space.
  • Once its coded up, send me the git repo and unit tests
  • I’ll bundle up the Dockerfile and TravisCI deployment. Errors would be reported on the travis-ci site and emailed to @team_infrastructure, though we may change this to also include create new issues on github automatically.

EDIT:

Thanks @StanSimmons for providing the url and example output.

1 Like
8

https://accounts.dallasmakerspace.org/member_count.php

{“updated”:“2017-12-10T18:01:33-06:00”,“monthly_members”:1021,“yearly_members”:99,“lifetime_members”:10,“starving_members”:168,“members”:1298,“addons”:376,“total”:1674}

This example was built by @AndrewLeCody

1 Like
9

smashing! Glad to know about that one.

I’m not seeing that up on our github or in the wiki. Did we document anything about it in the admin wiki?

10

5 posts were split to a new topic: Web Framework Discussion