JSON-RPC and XML-RPC test server

Connect

Over the same data and the same rules as the REST API. Besides them: system.echo (answers what it was given), system.time, system.sleep (up to ten seconds a request — for testing a client’s timeout) and system.fail (answers the error you ask for — for testing how a client handles one).

Try JSON-RPC

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":1,"method":"store.getProduct","params":[1]}'

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":2,"method":"store.listProducts","params":{"limit":3,"sort":"-price","filter":{"price_lt":30}}}'

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '[
  {"jsonrpc":"2.0","id":"a","method":"store.createCategory","params":{"category":{"name":"Garden","slug":"garden"}}},
  {"jsonrpc":"2.0","id":"b","method":"store.getCategory","params":[9]},
  {"jsonrpc":"2.0","method":"system.echo","params":["no id, no answer"]}
]'

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":3,"method":"store.createProduct","params":{"product":{"name":"Teapot","price":-1}}}'

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":4,"method":"store.getUnicorn","params":[1]}'

curl https://api.sondahub.com/jsonrpc \
  -H "Content-Type: application/json" \
  -d '{"jsonrpc":"2.0","id":5,"method":"system.fail","params":{"code":-32050,"message":"Upstream timed out","data":{"retry":true}}}'

Error codes

JSON-RPC answers HTTP 200 with an error object; XML-RPC a fault with the same codes (the interoperability set’s, for the first five). For the spec’s own codes the message is the spec’s words and the specifics are in data; for the others the message says what happened.

XML-RPC

The same methods, positional, with the spec’s types — int/i4, boolean, string, double, dateTime.iso8601, base64, struct, array — and the two common extensions: nil for an empty field and i8 for big integers. The introspection methods and system.multicall are there, as are system.getCapabilities and the test helpers.

curl https://api.sondahub.com/xmlrpc \
  -H "Content-Type: text/xml" \
  -d '<?xml version="1.0"?>
<methodCall>
  <methodName>store.getProduct</methodName>
  <params>
    <param><value><int>1</int></value></param>
  </params>
</methodCall>'

curl https://api.sondahub.com/xmlrpc \
  -H "Content-Type: text/xml" \
  -d '<?xml version="1.0"?>
<methodCall>
  <methodName>store.getProduct</methodName>
  <params>
    <param><value><int>999999</int></value></param>
  </params>
</methodCall>'

curl https://api.sondahub.com/xmlrpc \
  -H "Content-Type: text/xml" \
  -d '<?xml version="1.0"?>
<methodCall>
  <methodName>system.methodSignature</methodName>
  <params>
    <param><value><string>store.updateProduct</string></value></param>
  </params>
</methodCall>'

curl https://api.sondahub.com/xmlrpc \
  -H "Content-Type: text/xml" \
  -d '<?xml version="1.0"?>
<methodCall>
  <methodName>system.multicall</methodName>
  <params>
    <param><value><array><data>
      <value><struct><member><name>methodName</name><value><string>store.getCategory</string></value></member><member><name>params</name><value><array><data><value><int>1</int></value></data></array></value></member></struct></value>
      <value><struct><member><name>methodName</name><value><string>system.time</string></value></member><member><name>params</name><value><array><data></data></array></value></member></struct></value>
    </data></array></value></param>
  </params>
</methodCall>'

From code

Python (xmlrpc.client, in the standard library)

import xmlrpc.client

class Session(xmlrpc.client.SafeTransport):
    """Carries the session (your writes) from each answer to the next call."""
    token = None
    def send_headers(self, connection, headers):
        if self.token:
            headers.append(('X-Sondahub-Session', self.token))
        super().send_headers(connection, headers)
    def parse_response(self, response):
        self.token = response.getheader('X-Sondahub-Session') or self.token
        return super().parse_response(response)

hub = xmlrpc.client.ServerProxy('https://api.sondahub.com/xmlrpc', transport=Session(), allow_none=True)
print(hub.store.getProduct(1)['name'])
print(hub.store.listProducts({'limit': 5, 'filter': {'price_lt': 30}})['total'])
made = hub.store.createCategory({'name': 'Garden', 'slug': 'garden'})
print(hub.store.getCategory(made['id'])['name'])       # Garden: the session carried it
print(hub.system.methodSignature('store.updateProduct'))  # [['struct', 'int', 'struct']]

JavaScript (fetch)

// JSON-RPC needs no library: one fetch, and the session carried by hand
let session = null
async function call(method, params) {
  const res = await fetch('https://api.sondahub.com/jsonrpc', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json', ...(session ? { 'X-Sondahub-Session': session } : {}) },
    body: JSON.stringify({ jsonrpc: '2.0', id: crypto.randomUUID(), method, params }),
  })
  session = res.headers.get('X-Sondahub-Session') ?? session
  const answer = await res.json()
  if (answer.error) throw Object.assign(new Error(answer.error.message), answer.error)
  return answer.result
}

const made = await call('store.createCategory', { category: { name: 'Garden', slug: 'garden' } })
console.log((await call('store.getCategory', [made.id])).name)

What it answers

Also on sondahub

Fake REST API · Public GraphQL API · gRPC-Web & Connect · SOAP test server · WebSocket test server · SSE test server · Public MQTT broker · MCP test server · MCP OAuth test server · Writes that persist · OpenAPI mock server · Webhook tester · Chaos and rate limits · SAML test IdP and SP · SCIM 2.0 test server · OAuth 2.0 test server · Auth test endpoints · HTTP test endpoints · Fake JSON data · JSONPlaceholder alternative · Stripe sandbox · Twilio sandbox · SendGrid sandbox · Authorize.net sandbox · OpenAI sandbox · Anthropic sandbox

The mock APIs themselves: fake e-commerce API, fake IoT API, fake banking API, fake social media API, fake helpdesk API, fake flight booking API, fake user directory API. Built as the playground for LockFlare Sonda, the API client that lives on your computer.