mirror of
https://github.com/versia-pub/docs.git
synced 2025-12-06 14:28:20 +01:00
89 lines
3.8 KiB
Plaintext
89 lines
3.8 KiB
Plaintext
export const metadata = {
|
|
title: 'HTTP',
|
|
description:
|
|
'How Versia uses the HTTP protocol for all communications between instances.',
|
|
}
|
|
|
|
# HTTP
|
|
|
|
Versia uses the HTTP protocol for all communications between instances. HTTP requests must conform to certain standards to ensure compatibility between different implementations, as well as to ensure the security and integrity of the data being exchanged.
|
|
|
|
ALL kinds of HTTP requests/responses between instances **MUST** include a [Signature](/signatures), signed with either the relevant [User](/entities/user)'s private key or the [instance's private key](/entities/instance-metadata).
|
|
|
|
## Requests
|
|
|
|
<Row>
|
|
<Col>
|
|
<Properties name="HTTP Request">
|
|
<Property name="Accept" type="string" required={true}>
|
|
Must include `application/vnd.versia+json`, unless specified otherwise.
|
|
</Property>
|
|
<Property name="Content-Type" type="string" required={true}>
|
|
Must include `application/vnd.versia+json; charset=utf-8`, if the request has a body.
|
|
</Property>
|
|
<Property name="Versia-Signature" type="string" required={false}>
|
|
See [Signatures](/signatures) for more information.
|
|
</Property>
|
|
<Property name="Versia-Signed-By" type="URI" required={false} typeLink="/types#uri">
|
|
See [Signatures](/signatures).
|
|
</Property>
|
|
<Property name="Versia-Signed-At" type="string" required={false}>
|
|
See [Signatures](/signatures).
|
|
</Property>
|
|
<Property name="User-Agent" type="string" required={false}>
|
|
A string identifying the software making the request.
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
<Col sticky>
|
|
```http {{ 'title': 'Example Request' }}
|
|
POST https://bob.com/.versia/v0.6/inbox HTTP/1.1
|
|
# This specific endpoint returns plain JSON
|
|
Accept: application/json
|
|
User-Agent: CoolServer/1.0 (https://coolserver.com)
|
|
Versia-Signature: /CjB2L9bcvRg+uP19B4/rqy7Ji9/cqMFPlL3GVCIndnQjYyOpBzJEAl9weDnXm7Jrqa3y6sBC+EYWKThO2r9Bw==
|
|
Versia-Signed-By: example.com
|
|
Versia-Signed-At: 1729241687
|
|
```
|
|
</Col>
|
|
</Row>
|
|
|
|
## Rate limits
|
|
|
|
Implementations **MUST** respect the rate limits of remote instances.
|
|
|
|
IETF draft [draft-polli-ratelimit-headers-02](https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-02.html) **MUST** be used to communicate rate limits. Other rate limit headers/formats are not allowed.
|
|
|
|
<Note>
|
|
This IETF draft is, well, a draft. However, there are no standards for rate limiting in HTTP, so this is the best we have.
|
|
</Note>
|
|
|
|
## Responses
|
|
|
|
<Row>
|
|
<Col>
|
|
<Properties name="HTTP Response">
|
|
<Property name="Content-Type" type="string" required={true}>
|
|
Must include `application/vnd.versia+json; charset=utf-8`, unless specified otherwise.
|
|
</Property>
|
|
<Property name="Versia-Signature" type="string" required={false}>
|
|
See [Signatures](/signatures) for more information.
|
|
</Property>
|
|
<Property name="Versia-Signed-By" type="URI" required={false} typeLink="/types#uri">
|
|
See [Signatures](/signatures).
|
|
</Property>
|
|
<Property name="Versia-Signed-At" type="string" required={false}>
|
|
See [Signatures](/signatures).
|
|
</Property>
|
|
</Properties>
|
|
</Col>
|
|
<Col sticky>
|
|
```http {{ 'title': 'Example Response' }}
|
|
HTTP/1.1 200 OK
|
|
Content-Type: application/vnd.versia+json; charset=utf-8
|
|
Versia-Signature: /CjB2L9bcvRg+uP19B4/rqy7Ji9/cqMFPlL3GVCIndnQjYyOpBzJEAl9weDnXm7Jrqa3y6sBC+EYWKThO2r9Bw==+7BvnWKITyGyTwHbb6fVYwRx1I
|
|
Versia-Signed-By: example.com
|
|
Versia-Signed-At: 1729241717
|
|
```
|
|
</Col>
|
|
</Row> |