Overview

Making RPC Requests

Dydra provides a web service with an RPC interface.

To perform an API operation, you must encode a request message in either JSON or XML form, send the message (together with your authentication credentials) to the RPC endpoint using HTTP as the transport, and read back a response message. This interaction can be thought of as a remote procedure call, with the request message containing a method name and arguments for any parameters required by the method, and with the response message containing a result value or an error condition.

This endpoint supports both the JSON-RPC and XML-RPC protocols. The former is strongly preferred due to its relative simplicity and efficiency.

Note

Tooling and library support for XML-RPC is at the time of writing still more ubiquitous than for JSON-RPC, but XML-RPC messages are several times larger on the wire than the equivalent JSON-RPC messages. JSON-RPC also provides additional support for advanced features such as asynchronous batch operations. New applications should therefore always prefer JSON-RPC over XML-RPC whenever feasible.

Refer to the JSON-RPC 2.0 Specification and the XML-RPC Specification, respectively, for the particulars of these RPC protocols.

Table Of Contents

Previous topic

Native RPC Interface

Next topic

HTTP Endpoint