You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 18, 2024. It is now read-only.
Many of these pioneers have shaped the way in which we develop, deploy, consume, and support APIs, sparking a lot of innovation within the API space in the last decade.
59
59
@@ -101,4 +101,4 @@ Developers can’t be expected to visit an API area regularly, so an API communi
101
101
102
102
Even more than just a presence on these social networks, an API needs to have an offline presence too -- something that can be accomplished by attending conferences, meet-ups, and hackathons, for example. These activities will only serve to strengthen the API community.
103
103
104
-
*Re-used from [apievangilist.com](http://www.apievangelist.com) under a [Creative Commons](http://creativecommons.org/licenses/by-sa/3.0/) license and the [Federal Aviation Administration](http://services.faa.gov/).*
104
+
*Re-used from [apievangilist.com](http://www.apievangelist.com) under a [Creative Commons](http://creativecommons.org/licenses/by-sa/3.0/) license and the [Federal Aviation Administration](http://services.faa.gov/).*
Copy file name to clipboardExpand all lines: faq.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -83,7 +83,7 @@ Agencies' Information Resource Management (IRM) plans are comprehensive strategi
83
83
84
84
### How do the IRM plans relate to the open data policy?
85
85
86
-
In 2012, OMB established PortfolioStat accountability sessions to engage directly with agency leadership to assess the maturity and effectiveness of current IT management practices and address management opportunities and challenges. As part of the annual PortfolioStat process, agencies must update their IRM Strategic Plans to describe how they are meeting new and existing information life cycle management requirements. Specifically, agencies must describe how they have institutionalized and operationalized the interoperability and openness requirements in this Memorandum into their core processes across all applicable agency programs and stakeholders. The [FY13 OMB PortfolioStat Guidance](http://www.whitehouse.gov/sites/default/files/omb/memoranda/2013/m-13-09.pdf.) was issued on March 27, 2013.
86
+
In 2012, OMB established PortfolioStat accountability sessions to engage directly with agency leadership to assess the maturity and effectiveness of current IT management practices and address management opportunities and challenges. As part of the annual PortfolioStat process, agencies must update their IRM Strategic Plans to describe how they are meeting new and existing information life cycle management requirements. Specifically, agencies must describe how they have institutionalized and operationalized the interoperability and openness requirements in this Memorandum into their core processes across all applicable agency programs and stakeholders. The [FY13 OMB PortfolioStat Guidance](http://www.whitehouse.gov/sites/default/files/omb/memoranda/2013/m-13-09.pdf) was issued on March 27, 2013.
Copy file name to clipboardExpand all lines: glossary.md
+11-11
Original file line number
Diff line number
Diff line change
@@ -13,31 +13,31 @@ An application programming interface, which is a set of definitions of the ways
13
13
14
14
### API Analytics
15
15
16
-
Rate limiting will be part of any API platform, without some sort of usage log and analytics showing developers where they stand, the rate limits will cause nothing but frustration. Clearly show developers where they are at with daily, weekly or monthly API usage and provide proper relief valves allowing them to scale their usage properly. —*[source](http://apievangelist.com/buildingblocks/usage_logs_analytics.php)*
16
+
Rate limiting will be part of any API platform, without some sort of usage log and analytics showing developers where they stand, the rate limits will cause nothing but frustration. Clearly show developers where they are at with daily, weekly or monthly API usage and provide proper relief valves allowing them to scale their usage properly. —*[source](http://management.apievangelist.com/building-blocks.html)*
17
17
18
18
### API Documentation
19
19
20
20
Quality API documentation is the gateway to a successful API. API documentation needs to be complete, yet simple--a very difficult balance to achieve. This balance takes work and will take the work of more than one individual on an API development team to make happen.
21
21
22
-
API documentation can be written by developers of the API, but additional edits should be made by developers who were not responsible for deploying the API. As a developer, it’s easy to overlook parameters and other details that developers have made assumptions about. —*[source](http://apievangelist.com/buildingblocks/documentaton.php)*
22
+
API documentation can be written by developers of the API, but additional edits should be made by developers who were not responsible for deploying the API. As a developer, it’s easy to overlook parameters and other details that developers have made assumptions about. —*[source](http://management.apievangelist.com/building-blocks.html)*
23
23
24
24
### Application Library
25
25
26
-
Complete, functioning applications built on an API is the end goal of any API owner. Make sure and showcase all applications that are built on an API using an application showcase or directory. App showcases are a great way to showcase not just applications built by the API owner, but also showcase the successful integrations of ecosystem partners and individual developers. —*[source](http://apievangelist.com/buildingblocks/application_gallery.php)*
26
+
Complete, functioning applications built on an API is the end goal of any API owner. Make sure and showcase all applications that are built on an API using an application showcase or directory. App showcases are a great way to showcase not just applications built by the API owner, but also showcase the successful integrations of ecosystem partners and individual developers. —*[source](http://management.apievangelist.com/building-blocks.html)*
27
27
28
28
### Basic Auth
29
29
30
30
Basic Auth is a way for a web browser or application to provide credentials in the form of a username and password. Because Basic Auth is integrated into HTTP protocol it is the easiest way for users to authenticate with a RESTful API.
31
31
32
-
Basic Auth is easily integrated, however if SSL is not used, the username and password are passed in plain text and can be easily intercepted on the open Internet. —*[source](http://apievangelist.com/buildingblocks/basic_auth.php)*
32
+
Basic Auth is easily integrated, however if SSL is not used, the username and password are passed in plain text and can be easily intercepted on the open Internet. —*[source](http://management.apievangelist.com/building-blocks.html)*
33
33
34
34
### Catalog
35
35
36
36
A catalog is a collection of datasets or web services. —*[source](http://www.data.gov/glossary)*
37
37
38
38
### Code Library
39
39
40
-
Working code samples in all the top programming languages are common place in the most successful APIs. Documentation will describe in a general way, how to use an API, but code samples will speak in the specific language of developers. —*[source](http://apievangelist.com/buildingblocks/code_libraries.php)*
40
+
Working code samples in all the top programming languages are common place in the most successful APIs. Documentation will describe in a general way, how to use an API, but code samples will speak in the specific language of developers. —*[source](http://management.apievangelist.com/building-blocks.html)*
41
41
42
42
### Content API
43
43
@@ -53,7 +53,7 @@ A value or set of values representing a specific concept or concepts. Data becom
53
53
54
54
### /Data page
55
55
56
-
A hub for data discovery which provides a common location that lists and links to an organization’s datasets. Such a hub is often located at www.example.com/data. —*[source](policy-memo/)*
56
+
A hub for data discovery which provides a common location that lists and links to an organization’s datasets. Such a hub is often located at www.example.com/data. —*[source](http://project-open-data.github.io/policy-memo/)*
57
57
58
58
### Dataset
59
59
@@ -75,11 +75,11 @@ An association between a binding and a network address, specified by a URI, that
75
75
76
76
Errors are an inevitable part of API integration, and providing not only a robust set of clear and meaningful API error response codes, but a clear listing of these codes for developers to follow and learn from is essential.
77
77
78
-
API errors are directly related to frustration during developer integration, the more friendlier and meaningful they are, the greater the chance a developer will move forward after encountering an error. Put a lot of consideration into your error responses and the documentation that educates developers. —*[source](http://apievangelist.com/buildingblocks/error_response_codes.php)*
78
+
API errors are directly related to frustration during developer integration, the more friendlier and meaningful they are, the greater the chance a developer will move forward after encountering an error. Put a lot of consideration into your error responses and the documentation that educates developers. —*[source](http://management.apievangelist.com/building-blocks.html)*
79
79
80
80
### GitHub
81
81
82
-
GitHub is a social coding platform allowing developers to publicly or privately build code repositories and interact with other developers around these repositories--providing the ability to download or fork a repository, as well as contribute back, resulting in a collaborative environment for software development. —*[source](http://apievangelist.com/buildingblocks/github.php)*
82
+
GitHub is a social coding platform allowing developers to publicly or privately build code repositories and interact with other developers around these repositories--providing the ability to download or fork a repository, as well as contribute back, resulting in a collaborative environment for software development. —*[source](http://management.apievangelist.com/building-blocks.html)*
83
83
84
84
### Hackathon
85
85
@@ -119,7 +119,7 @@ To facilitate common understanding, a number of characteristics, or attributes,
119
119
120
120
### OAuth
121
121
122
-
An open standard for authorization. It allows users to share their private resources stored on one site with another site without having to hand out their credentials, typically username and password. —*[source](http://apievangelist.com/buildingblocks/oauth.php)*
122
+
An open standard for authorization. It allows users to share their private resources stored on one site with another site without having to hand out their credentials, typically username and password. —*[source](http://management.apievangelist.com/building-blocks.html)*
123
123
124
124
### Open Source Software
125
125
@@ -155,7 +155,7 @@ An XML schema defines the structure of an XML document. An XML schema defines th
155
155
156
156
Software Development Kits (SDK) are the next step in providing code for developers, after basic code samples. SDKs are more complete code libraries that usually include authentication and production ready objects, that developers can use after they are more familiar with an API and are ready for integration.
157
157
158
-
Just like with code samples, SDKs should be provided in as many common programming languages as possible. Code samples will help developers understand an API, while SDKs will actually facilitate their integration of an API into their application. When providing SDKs, consider a software licensing that gives your developers as much flexibility as possible in their commercial products. —*[source](http://apievangelist.com/buildingblocks/software_development_kits.php)*
158
+
Just like with code samples, SDKs should be provided in as many common programming languages as possible. Code samples will help developers understand an API, while SDKs will actually facilitate their integration of an API into their application. When providing SDKs, consider a software licensing that gives your developers as much flexibility as possible in their commercial products. —*[source](http://management.apievangelist.com/building-blocks.html)*
159
159
160
160
### Service-Oriented-Architecture
161
161
@@ -171,7 +171,7 @@ A specification and complete framework implementation for describing, producing,
171
171
172
172
### Terms of Service
173
173
174
-
Terms of Service provide a legal framework for developers to operate within. They set the stage for the business development relationships that will occur within an API ecosystem. Terms of Service should protect the API owner's company, assets and brand, but should also provide assurances for developers who are building businesses on top of an API. —*[source](http://apievangelist.com/buildingblocks/terms_of_use__conditions.php)*
174
+
Terms of Service provide a legal framework for developers to operate within. They set the stage for the business development relationships that will occur within an API ecosystem. Terms of Service should protect the API owner's company, assets and brand, but should also provide assurances for developers who are building businesses on top of an API. —*[source](http://management.apievangelist.com/building-blocks.html)*
0 commit comments