<?xml version="1.0" encoding="UTF-8"?> <chapter version="5.0" xml:id="chapter.overview" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"> <title>Overview</title> <simplesect> <title>Release compatibility of the API</title> <para> The Perforce Web API is subject to change from release to release, and is not guaranteed to support the exact same methods from one release to the next. However, applications that you create using the Web API can run against previous releases of Perforce and will probably run against later releases of Perforce. </para> <para> Support for specific features depends on the version of Perforce and the API that you use. </para> </simplesect> <simplesect> <title>Purpose of the API</title> <para> The Perforce Web API enables you to create applications that interact with end users, send commands to the Perforce server and process data returned from the versioning service. The API is a programmatic interface, and does not send commands directly to the server. </para> <para> Not all Perforce commands are supported by the Web API. Commands that operate on the user's client workspace are generally not supported. In general, you can not submit or alter files on behalf of a user with the Perforce Web API. You can, however, create branches, edit workspace metadata, and other operations that can establish custom workflow or automate administrative tasks. </para> </simplesect> <simplesect> <title>Architecture of the API</title> <para> The Perforce Web API is intended to be executed in a web server or integrated into another web application. Once available, it provides HTTP access to executing Perforce commands. Each HTTP method is stateless, except for authentication methods that use a stored token. </para> </simplesect> </chapter>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#2 | 13972 | tjuricek |
Removing old microservice implementations. The system is now mostly a monolith. Eventually there will be a websocket service. |
||
#1 | 13458 | tjuricek |
Revising P4 Web API docbook documentation to become the Perforce Web Services guide. Right now this is just focused on the Qt SDK. The remaining protocol documentation, etc, will happen eventually. |
||
//guest/perforce_software/helix-web-services/main/p4_web_api/p4_web_api/docbook/xml/01_overview.xml | |||||
#1 | 13412 | tjuricek |
Initial version of the web-services mainline. This is a collection of several projects, that will likely often get released together, though many of them may not always be relevant. See the README for more information. |