The api.data.gov shared service is set up for use here at GSA and there's a general push to try and get all of our agency's APIs using it. The main functionalities to using it are:
provides api key management (example signup form here)
provides robust api analytics (e.g. who is using the api, how are they using it, how much, etc)
create usage tiers for privileged users
makes it easier to update and maintain the API in the future by having the api.data.gov url serve as a platform underneath which you can do work.
We already have https://api.gsa.gov/set up for agency-wide use, so there's technical changes needed to set this up, it'd just be a matter of changing what's on https://www.data.gov/developers/apis. Right now, that lists the http://catalog.data.gov/api/3/ endpoint, but that means that we don't have the functional benefits I listed above.
Given that GSA already has the api.gsa.gov domain set up and a standard for URL design, I took the liberty of going ahead and setting up api.gsa.gov/systems/datagov/ as a proxy to catalog.data.gov/api/. You can see it in action here (vs. the original here)
However, one option that might work better would be to instead make it easier on all involved and let me spin up another instance of GSA's API documentation template and it'd just be a matter of linking off to that once I got it all ready.
gbinal
commented
6 years ago
The api.data.gov shared service is set up for use here at GSA and there's a general push to try and get all of our agency's APIs using it. The main functionalities to using it are:
We already have
https://api.gsa.gov/set up for agency-wide use, so there's technical changes needed to set this up, it'd just be a matter of changing what's on https://www.data.gov/developers/apis. Right now, that lists thehttp://catalog.data.gov/api/3/endpoint, but that means that we don't have the functional benefits I listed above.Given that GSA already has the
api.gsa.govdomain set up and a standard for URL design, I took the liberty of going ahead and setting upapi.gsa.gov/systems/datagov/as a proxy tocatalog.data.gov/api/. You can see it in action here (vs. the original here)If you're game, here's all that we'd need to do.
However, one option that might work better would be to instead make it easier on all involved and let me spin up another instance of GSA's API documentation template and it'd just be a matter of linking off to that once I got it all ready.