1481: API - Revision history

172.70.85.4: /* Explanation */ rationalise invisibly

2025-02-13T13:25:00Z

‎Explanation: rationalise invisibly

172.68.174.147: Replace link to disambiguation page with intended target

2025-02-13T03:25:08Z

Replace link to disambiguation page with intended target

FaviFake: Fixed old http:// link

2023-06-27T08:40:25Z

Fixed old http:// link

Jacky720: rv

2022-05-04T21:17:47Z

Show changes

Ex Kay Cee Dee at 21:16, 4 May 2022

2022-05-04T21:16:16Z

Show changes

Jacky720: rv

2022-05-04T20:56:12Z

Show changes

Ex Kay Cee Dee at 20:45, 4 May 2022

2022-05-04T20:45:52Z

Show changes

Davidy22: Reverted edits by X. K. C. D. (talk) to last revision by Öbc

2022-05-04T02:00:18Z

Reverted edits by X. K. C. D. (talk) to last revision by Öbc

Show changes

X. K. C. D. at 00:44, 4 May 2022

2022-05-04T00:44:38Z

Show changes

Öbc: /* Explanation */

2021-03-15T12:40:29Z

‎Explanation

@@ Line 10: / Line 10: @@
 This comic presents a web site designed for human readers as if it had an API ({{w|application programming interface}}) designed for machine-to-machine {{w|web service}}. An API is a set of instructions about a computer program, intended to be used by developers of other computer programs, so the two programs can interoperate more easily. The documentation explains how to send commands to the program, and how the output will be returned.
-Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g., a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
+Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g., a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading Style Sheets|CSS}} and perhaps JavaScript layout code). The "documentation" may also be {{w|Document type definition|DTD}} which tells the XML parser info about this particular {{w|XML}} format, i.e. XHTML.
 In order for a program to process a generic web site designed for human viewing, the program needs to use {{w|web scraping}} techniques, which often break when the web site design changes in subtle ways that a human might never notice. Therefore, developers [http://www.rubyinside.com/ruby-gets-a-stylish-html-scraper-scrapi-140.html prefer to have proper APIs] with well-defined machine-readable formats, stable interfaces and documentation that actually describes the semantics of the data.

@@ Line 11: / Line 11: @@
 Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g., a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
-"documentation" may also be {{w|DTD}} which tells the XML parser info about this particular {{w|XML}} format, i.e. XHTML.
+"documentation" may also be {{w|Document_type_definition|DTD}} which tells the XML parser info about this particular {{w|XML}} format, i.e. XHTML.
 In order for a program to process a generic web site designed for human viewing, the program needs to use {{w|web scraping}} techniques, which often break when the web site design changes in subtle ways that a human might never notice. Therefore, developers [http://www.rubyinside.com/ruby-gets-a-stylish-html-scraper-scrapi-140.html prefer to have proper APIs] with well-defined machine-readable formats, stable interfaces and documentation that actually describes the semantics of the data.

@@ Line 10: / Line 10: @@
 This comic presents a web site designed for human readers as if it had an API ({{w|application programming interface}}) designed for machine-to-machine {{w|web service}}. An API is a set of instructions about a computer program, intended to be used by developers of other computer programs, so the two programs can interoperate more easily. The documentation explains how to send commands to the program, and how the output will be returned.
-Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g. a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
+Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g., a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
 "documentation" may also be {{w|DTD}} which tells the XML parser info about this particular {{w|XML}} format, i.e. XHTML.
 In order for a program to process a generic web site designed for human viewing, the program needs to use {{w|web scraping}} techniques, which often break when the web site design changes in subtle ways that a human might never notice. Therefore, developers [http://www.rubyinside.com/ruby-gets-a-stylish-html-scraper-scrapi-140.html prefer to have proper APIs] with well-defined machine-readable formats, stable interfaces and documentation that actually describes the semantics of the data.
-For example, Google has an [https://developers.google.com/youtube/v3/getting-started official API for version 3 of their Youtube web service]. But developers who don't want to hassle with the required API key or the costs associated with its use sometimes just [http://stackoverflow.com/questions/20407107/scraping-youtube-mix-playlist-id-for-a-video scrape the regular YouTube web site]. So someone could publish this comic with a YouTube URL as a convoluted hint to developers that there is an alternative to the official API.
+For example, Google has an [https://developers.google.com/youtube/v3/getting-started official API for version 3 of their YouTube web service]. But developers who don't want to hassle with the required API key or the costs associated with its use sometimes just [https://stackoverflow.com/questions/20407107/scraping-youtube-mix-playlist-id-for-a-video scrape the regular YouTube web site]. So, someone could publish this comic with a YouTube URL as a convoluted hint to developers that there is an alternative to the official API.
 The API keys section is a step-by-step description of how a web page is protected with {{w|HTTP Secure}} (HTTPS). The {{w|Transport Layer Security}} (TLS) protocol uses an {{w|elliptic curve Diffie–Hellman}} (ECDH) key signed using {{w|Rivest-Shamir-Adleman}} (RSA) encryption, which is stored in an {{w|X.509}} certificate. Normally, the browser or operating system does this behind the scenes, so most web developers and users do not need to know these details.
-The access limits mentioned in the title text says that the API can be used for 86,400 seconds each day. At first this may appear to be a strange arbitrary number, however it is in fact the total number of seconds in 24 hours, essentially meaning there is no limit on most days. The {{w|International Earth Rotation and Reference Systems Service}} (IERS) is the organization that decides when to add {{w|leap seconds}}, which account for slight anomalies in the Earth's rotation as compared to the {{w|mean solar day}}. These leap seconds will mean that the website is available for one extra second occasionally, although IERS decisions are based on actual Earth rotation rates and they of course wouldn't respond to requests for leap seconds in order to lengthen the number of seconds that a web site would be available for in a given calendar day.  The API does not discuss the issue that some days have 23 or 25 hours due to {{w|Daylight saving time|daylight saving time}} in the U.S. and {{w|Summer time|summer time}} in Europe and some other places. This suggests that the web service tracks time via {{w|UTC}}.
+The access limits mentioned in the title text says that the API can be used for 86,400 seconds each day. At first this may appear to be a strange arbitrary number; however, it is in fact the total number of seconds in 24 hours, essentially meaning there is no limit on most days. The {{w|International Earth Rotation and Reference Systems Service}} (IERS) is the organization that decides when to add {{w|leap seconds}}, which account for slight anomalies in the Earth's rotation as compared to the {{w|mean solar day}}. These leap seconds will mean that the website is available for one extra second occasionally, although IERS decisions are based on actual Earth rotation rates, and they of course wouldn't respond to requests for leap seconds in order to lengthen the number of seconds that a web site would be available for in a given calendar day.  The API does not discuss the issue that some days have 23 or 25 hours due to {{w|Daylight saving time|daylight saving time}} in the U.S. and {{w|Summer time|summer time}} in Europe and some other places. This suggests that the web service tracks time via {{w|UTC}}.
 ==Transcript==

@@ Line 10: / Line 10: @@
 This comic presents a web site designed for human readers as if it had an API ({{w|application programming interface}}) designed for machine-to-machine {{w|web service}}. An API is a set of instructions about a computer program, intended to be used by developers of other computer programs, so the two programs can interoperate more easily. The documentation explains how to send commands to the program, and how the output will be returned.
-Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by all web pages. The "requested data" is the actual content (e.g. a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
+Many web APIs are designed to return data in {{w|XML}} format. But in this case, the XML is {{w|XHTML}}, a version of the language that is used by most web pages. The "requested data" is the actual content (e.g. a blog post), and "documentation" refers (in an obscure way) to the parts of a web page that control how it looks on the screen (e.g. {{w|Cascading_Style_Sheets|CSS}} and perhaps JavaScript layout code). The
 "documentation" may also be {{w|DTD}} which tells the XML parser info about this particular {{w|XML}} format, i.e. XHTML.