{
    "version" : "https://jsonfeed.org/version/1",
    "content" : "news",
    "type" : "single",
    "title" : "Producing APIs through Data.gov |Digital.gov",
    "description": "Producing APIs through Data.gov",
    "home_page_url" : "/preview/gsa/digitalgov.gov/bc-archive-content-3/","feed_url" : "/preview/gsa/digitalgov.gov/bc-archive-content-3/2013/04/30/producing-apis-through-data-gov/index.json","item" : [
    {"title" :"Producing APIs through Data.gov","summary" : "One way agencies can offer APIs for their data is to use the built–in functionality of Data.gov. The information that is hosted as interactive datasets have an API layer which agencies can make available through documentation in the developer’s section of the agency’s website. The guide below will help you do this. Process Upload a dataset","date" : "2013-04-30T01:07:53-04:00","date_modified" : "2025-01-27T19:42:55-05:00","authors" : {"gray-brooks" : "Gray Brooks"},"topics" : {
        
            "application-programming-interface" : "Application programming interface",
            "open-data" : "Open data",
            "software-engineering" : "Software engineering"
            },"branch" : "bc-archive-content-3",
      "filename" :"2013-04-30-producing-apis-through-data-gov.md",
      
      "filepath" :"news/2013/04/2013-04-30-producing-apis-through-data-gov.md",
      "filepathURL" :"https://github.com/GSA/digitalgov.gov/blob/bc-archive-content-3/content/news/2013/04/2013-04-30-producing-apis-through-data-gov.md",
      "editpathURL" :"https://github.com/GSA/digitalgov.gov/edit/bc-archive-content-3/content/news/2013/04/2013-04-30-producing-apis-through-data-gov.md","slug" : "producing-apis-through-data-gov","url" : "/preview/gsa/digitalgov.gov/bc-archive-content-3/2013/04/30/producing-apis-through-data-gov/","content" :"\u003cdiv class=\"image\"\u003e\n  \u003cimg\n    src=\"https://s3.amazonaws.com/digitalgov/_legacy-img/2014/08/250-x-86-API-letter-blocks-23575697-Hemera-Technologies-PhotoObjects.net-Thinkstock-87667306.jpg\"\n    alt=\"Children\u0026#39;s building blocks letters spelling A P I.\"/\u003e\u003c/div\u003e\n\n\n\u003cp\u003eOne way agencies can offer APIs for their data is to use the built–in functionality of \u003ca href=\"http://www.data.gov/\"\u003eData.gov\u003c/a\u003e. The information that is hosted as interactive datasets have an API layer which agencies can make available through documentation in the developer’s section of the agency’s website. The guide below will help you do this.\u003c/p\u003e\n\u003ch2 id=\"process\"\u003eProcess\u003c/h2\u003e\n\u003col\u003e\n\u003cli\u003eUpload a dataset as an interactive dataset in Data.gov. A. Your agency should have a Data.gov point–of–contact who can help. If you need help finding yours, \u003ca href=\"http://www.data.gov/webform/contact-us\"\u003econtact the Data.gov team\u003c/a\u003e.\u003c/li\u003e\n\u003cli\u003eOnce the dataset is live in Data.gov’s \u003ca href=\"https://explore.data.gov/catalog/next-gen\"\u003einteractive datasets catalog\u003c/a\u003e, click on ‘Export’ (in the top right), then ‘API’. You’ll need the resulting information in a moment.\u003c/li\u003e\n\u003cli\u003eCreate an html page within your agency’s developer hub that will serve as an API homepage for this documentation (e.g., \u003ca href=\"https://www.agency.gov/developer/name-of-api)\"\u003ewww.agency.gov/developer/name-of-api)\u003c/a\u003e.\u003c/li\u003e\n\u003cli\u003eCustomize the template below with the appropriate API information from your interactive dataset (see #2) and add the information to the API homepage that you’ve created. A. For the API URL, copy the ‘API Access Endpoint’, remove the ‘json’ suffix, and insert ‘[format]’.B. The ‘Response Format’, ‘Type’, and ‘Authentication’ fields do not need customizing.C. For the ‘Example Requests’, begin with the dataset’s ‘API Access Endpoint’, and customize it with parameters and values that demonstrate potential uses of this dataset’s API.D. For the Parameter’s Chart, describe each of the parameters listed in the ‘Column IDs’ and provide examples that are used in the dataset.  It may be appropriate to combine some Column IDs, for instance, along the lines of the example below.\u003c/li\u003e\n\u003cli\u003eInclude a link to the ‘\u003ca href=\"http://dev.socrata.com/\"\u003eFurther Developer Documentation\u003c/a\u003e‘ that Socrata offers.\u003c/li\u003e\n\u003cli\u003eLink to any \u003ca href=\"/preview/gsa/digitalgov.gov/bc-archive-content-3/2013/05/16/api-release-kit/\" title=\"API Release Kit\"\u003eadditional developer resources\u003c/a\u003e you create to a ‘Related Resources’ section.\u003c/li\u003e\n\u003c/ol\u003e\n\u003ch2 id=\"template\"\u003eTemplate\u003c/h2\u003e\n\u003ch3 id=\"name-of-dataset\"\u003eName of Dataset\u003c/h3\u003e\n\u003cp\u003eThis section is a description of the dataset and some background for the API. Use plain language to describe what the underlying data is and what developers can do with it. Avoid insider language and acronyms—remember to ask whether someone who is new to your agency’s work would easily understand it.\u003c/p\u003e\n\u003ch3 id=\"api-url\"\u003eAPI URL\u003c/h3\u003e\n\u003cp\u003e\u003ca href=\"http://explore.data.gov/resource/_%5Bdataset-id%5D\"\u003ehttp://explore.data.gov/resource/_[dataset-id]\u003c/a\u003e_.\u003c/p\u003e\n\u003cp\u003e[format]\u003c/p\u003e\n\u003ch3 id=\"response-format\"\u003eResponse Format\u003c/h3\u003e\n\u003cp\u003ejson, xml\u003c/p\u003e\n\u003ch3 id=\"type\"\u003eType\u003c/h3\u003e\n\u003cp\u003eHTTP GET\u003c/p\u003e\n\u003ch3 id=\"authentication\"\u003eAuthentication\u003c/h3\u003e\n\u003cp\u003eNone required\u003c/p\u003e\n\u003ch3 id=\"example-request\"\u003eExample Request\u003c/h3\u003e\n\u003cp\u003e[See the \u003ca href=\"http://gsa.gov/portal/content/162379\"\u003eexample\u003c/a\u003e for a model to use]\u003c/p\u003e\n\u003ch3 id=\"parameters-and-values\"\u003eParameters and Values\u003c/h3\u003e\n\u003ctable border=\"1\" cellspacing=\"1\" cellpadding=\"5\"\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cstrong\u003eParameter\u003c/strong\u003e\n    \u003c/td\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt;Type\u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt;Description\u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt;Sample Values\u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n      \u003cstrong\u003e \u003c/strong\u003e\n    \u003c/td\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt; \u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt; \u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n  \u0026lt;strong\u0026gt; \u0026lt;/strong\u0026gt;\n\u0026lt;/td\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n    \u003c/td\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\n    \u003c/td\u003e\n\u003cpre\u003e\u003ccode\u003e\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\n\u0026lt;td\u0026gt;\n\u0026lt;/td\u0026gt;\n\u003c/code\u003e\u003c/pre\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\u003cp\u003e[See the \u003ca href=\"http://gsa.gov/portal/content/162379\"\u003eexample\u003c/a\u003e for a model to use]\u003c/p\u003e\n\u003ch3 id=\"further-developer-documentation\"\u003eFurther Developer Documentation\u003c/h3\u003e\n\u003cp\u003e\u003ca href=\"http://dev.socrata.com/\"\u003eSocrata’s SODA Documentation\u003c/a\u003e\u003c/p\u003e\n\u003ch3 id=\"related-resources\"\u003eRelated Resources\u003c/h3\u003e\n\u003cp\u003eInclude \u003ca href=\"/preview/gsa/digitalgov.gov/bc-archive-content-3/2013/05/16/api-release-kit/\" title=\"API Release Kit\"\u003eany additional resources\u003c/a\u003e your team can offer developers.\u003c/p\u003e\n\u003ch2 id=\"completed-example\"\u003eCompleted Example\u003c/h2\u003e\n\u003cp\u003eTo see this model in action, check out \u003ca href=\"http://gsa.gov/portal/content/162379\"\u003eGSA’s Per Diem API\u003c/a\u003e.\u003c/p\u003e\n"}
  ]
}