View source for Help:API

{{Developer manual
 |parent=Help:Architecture guide‎‎
 |displaytitle=API modules
 |sort=y
}}{{Interlanguage}}

The '''semantic API modules''' (SMW API) are provided by [[Semantic MediaWiki]] and related extensions enabling external components or data services to access [[Help:Properties and types|semantically annotated information]] stored in the Semantic MediaWiki database via several available interfaces  using a standardized HTTP request.

{{Callout
 |The semantic API modules allow to select and retrieve, i.e. read annotated information stored on the wiki. If information has to be [[mws:API:Changing wiki content|written to the wiki]] then the regular [[mws:API:Main page|MediaWiki API-modules]] available for [[mws:API:Edit|editing]] must be used. This is to ensure that the corresponding wiki page is updated the same way as when one would edit on-wiki. Moreover this also makes sure that no information accessible via a wiki page revision is lost.
}}

== API modules ==
{{#ask:
 [[Category:API]]
 [[Has keyword::API module]]
 [[Is deprecated::false]]
 |?Has description=Description
 |?Has component=Provided&nbsp;by|+align=center
 |?Has minimum version=Since|+align=center
 |headers=plain
 |mainlabel=Help page
 |sort=Has component,Has name
 |order=descending,ascending
 |default=No API module has been documented yet.
 |intro=<b>Active modules</b>
 |format=broadtable
 |class=smwtable-clean sortable
}}

{{#ask:
 [[Category:API]]
 [[Has keyword::API module]]
 [[Is deprecated::true]]
 |?Has description=Description
 |?Has component=Provided&nbsp;by|+align=center
 |?Has minimum version=Since|+align=center
 |headers=plain
 |mainlabel=Help page
 |sort=Has component,Has name
 |order=descending,ascending
 |default=No deprecated API module has been documented yet.
 |intro=<b>Deprecated modules</b>
 |format=broadtable
 |class=smwtable-clean sortable
}}

== Configuration parameters ==
* Manual page on {{Config|$wgCrossSiteAJAXdomains|mwo=1}} − Allows to specify domains that may make cross-site Ajax requests to the MediaWiki API for [[wikipedia:en:Cross-origin resource sharing|Cross-origin resource sharing (CORS)]]
* Manual page on {{Config|$wgEnableAPI|mwo=1}} − Allows to enable direct access to the MediaWiki API through "api.php" (deprecated in MediaWiki 1.31 and removed in 1.32, i.e. the API cannot be disabled for reading.)
* Manual page on {{Config|$wgEnableWriteAPI|mwo=1}} − Allows the MediaWiki API to be used through "api.php" to perform write operations (page edits, uploads, etc.) when an authorized user accesses it (deprecated in MediaWiki 1.31 and removed in 1.32, i.e. the API cannot be disabled for writing.)

== See also ==
* General [[/README/]] of the SMW API as provided via the source code
* Help page on [[/Troubleshooting/]] the SMW API
* Help page on [[Serialization (JSON)]] performed by the SMW API
* [https://sourceforge.net/p/semediawiki/mailman/message/28105511/ RFC concerning the SMW API on the SMW developer list, September 18, 2011]
* Video of a [https://www.youtube.com/watch?v=XQfXCJzac30 related talk at SMWCon 2011 fall in Berlin]

<div style="display: none">
{{#scite:gh:smw:3052
 |type=pullrequest
 |url=https://github.com/SemanticMediaWiki/SemanticMediaWiki/pull/3052
}}
{{doc.info
 |master page=Help:API
 |status=effective
 |progress=100
 |priority=2
 |minversion=3.0.0
}}
</div>
[[Category:API| ]]