Stamps API

8 endpoints.

Get pages that contain at least one stamp in the archive

GEThttp://localhost:3000/api/archives/{id}/stamps

Get pages that contain at least one stamp in the archive.

How access changes the result

• For a guest visitor whose scope excludes this archive, this answers 404, not 403 — deliberately indistinguishable from an archive that does not exist, so the response cannot be used to probe for archives outside the guest's scope.

Path parameters

idstringrequired

ID of the archive.

Responses

200Success response

{
  "result": [
    ""
  ]
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpath

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Get the stamps linked to the page

GEThttp://localhost:3000/api/archives/{id}/stamps/{index}

Get the stamps linked to the page.

How access changes the result

• For a guest visitor whose scope excludes this archive, this answers 404, not 403 — deliberately indistinguishable from an archive that does not exist, so the response cannot be used to probe for archives outside the guest's scope.

Path parameters

idstringrequired

ID of the archive.

indexintegerrequired

Page of the archive.

Responses

200Success response

{
  "result": [
    {
      "content": "Lorem ipsum dolore",
      "position": "12,34"
    }
  ]
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpathindexpath

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Add a stamp annotation

PUThttp://localhost:3000/api/archives/{id}/stamps/{index}

Add a new Stamp to the page at the given coordinates.

Path parameters

idstringrequired

ID of the archive.

indexintegerrequired

Page of the archive.

Query parameters

contentstringoptional

Text of the stamp.

positionstringoptional

Position of the stamp in the page.

Responses

200Success response

{
  "operation": "add_stamp",
  "stamp_id": "",
  "success": 0
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpathindexpathcontentquerypositionquery

This endpoint needs an administrator token — a guest (read-only) token is refused by the server.

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Delete Stamp

DELETEhttp://localhost:3000/api/stamps/{id}

Remove a stamp from an Archive.

Path parameters

idstringrequired

ID of the stamp.

Responses

200Success response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423The Stamp is currently locked for modification

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpath

This endpoint needs an administrator token — a guest (read-only) token is refused by the server.

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Get Stamp

GEThttp://localhost:3000/api/stamps/{id}

Get a stamp from an Archive.

Path parameters

idstringrequired

ID of the stamp.

Responses

200Success response

{
  "content": "Lorem ipsum dolore",
  "position": "12,34"
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423The Stamp is currently locked for modification

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpath

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

Update Stamp

PUThttp://localhost:3000/api/stamps/{id}

Update a stamp from an Archive.

Path parameters

idstringrequired

ID of the stamp.

Query parameters

contentstringoptional

Text of the stamp.

positionstringoptional

Position of the stamp in the page.

Responses

200Success response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

400Error response

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

423The Stamp is currently locked for modification

{
  "error": "",
  "operation": "",
  "success": 0,
  "successMessage": ""
}

ServerAPI token

idpathcontentquerypositionquery

This endpoint needs an administrator token — a guest (read-only) token is refused by the server.

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

tank_stamps_by_page

GEThttp://localhost:3000/api/tankoubons/{id}/stamps/{page}

Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.

The handler is tank_stamps_by_page in crates/lanrurugi-api/src/stamps.rs:58.

Responses

200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/stamps.rs:52.

This response carries no example body.

ServerAPI token

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.

tank_add_stamp

PUThttp://localhost:3000/api/tankoubons/{id}/stamps/{page}

Not yet described in this reference. This endpoint is listed because the server registers it, but its request and response shapes have not been written down yet.

The handler is tank_add_stamp in crates/lanrurugi-api/src/stamps.rs:72.

Responses

200The endpoint responded. Its exact shape is not documented yet — see the handler at crates/lanrurugi-api/src/stamps.rs:52.

This response carries no example body.

ServerAPI token

This endpoint needs an administrator token — a guest (read-only) token is refused by the server.

SendCopy as cURL

Your own instance address. Requests go from this browser straight to it.