rayriffy-h-api
An APIs for Riffy H
MIT License
Stars
3
Ecosystems:
TypeScript
Riffy H API
An APIs for Riffy H
Requirements
- Node LTS
API
The API is based on HTTPS requests and JSON responses. The stable HTTPS endpoint for the latest version is: https://h.api.rayriffy.com/v1
HTTP status Codes
The following HTTP status codes are returned by the API
| Status Code | Description |
|---|---|
| 200 | Request successful |
| 202 | Request has been accepted for further processing, which will be completed sometime later. |
| 400 | Problem with the request |
| 401 | Valid JWT token is not specified |
| 404 | Request / Route is not found |
| 405 | Request method is invalid |
| 500 | Error on the internal server |
Otherwise, successful response can be check by using modulo operation
const isSuccessful = res.code % 100 === 2
Response structure
The following JSON data is returned in the response body
| Property | Type | Description |
|---|---|---|
| status | String | Give the result of the request that it's success or not |
| code | Number | Request status code. Note that this code does not related to HTTP status code |
| response.message | String | Result summary |
| response.data | Any | (Optional) Provide useful data for processing |
Get encoded image
Render a SFW version of an image that can be decodable
HTTP request
GET /encode/:id
Path parameters
| Parameter | Description |
|---|---|
| id | ID of an hentai |
Response
Returns a 200 HTTP status code and a JSON object with the following data.
| Property | Type | Description |
|---|---|---|
| response.data | String | Base64 encoded string of jpeg image |
{
"status": "success",
"code": 201,
"response": {
"message": "image encoded",
"data": "data:image/jpeg;base64,<base64 data>"
}
Get gallery
Get JSON format of NHentai gallery
HTTP request
GET /gallery/:id
Path parameters
| Parameter | Description |
|---|---|
| id | ID of an hentai |
Response
Returns a 200 HTTP status code and a JSON object with the following data.
| Property | Type | Description |
|---|---|---|
| response.data | IHentai | Gallery of requested ID |
{
"status": "success",
"code": 201,
"response": {
"message": "gallery obtained",
"data": {
"id": 153584,
"media_id": "891754",
"title": {
"japanese": "[100] ( ) []",
"pretty": "Fuuki Iinchou no Oshigoto",
"english": "[100yen locker] Fuuki Iinchou no Oshigoto (Seifuku Musou Houkago Tokubetsu Koushuu Hen) [Decensored]"
},
"images": {
"cover": {
"h": 508,
"t": "p",
"w": 350
},
"pages": [
{
"h": 1600,
"t": "p",
"w": 1102
},
{
"h": 1600,
"t": "p",
"w": 1104
},
{
"h": 1600,
"t": "p",
"w": 1104
},
{
"h": 1600,
"t": "p",
"w": 1105
}
]
},
"tags": [
{
"id": 6346,
"name": "japanese",
"type": "language"
},
{
"id": 8693,
"name": "uncensored",
"type": "tag"
},
{
"id": 10314,
"name": "schoolgirl uniform",
"type": "tag"
},
{
"id": 13720,
"name": "nakadashi",
"type": "tag"
},
{
"id": 20035,
"name": "x-ray",
"type": "tag"
},
{
"id": 20905,
"name": "full color",
"type": "tag"
},
{
"id": 25601,
"name": "small breasts",
"type": "tag"
},
{
"id": 28521,
"name": "voyeurism",
"type": "tag"
},
{
"id": 29513,
"name": "100yen locker",
"type": "artist"
},
{
"id": 33173,
"name": "manga",
"type": "category"
}
]
}
}
}
Get related gallery
Get 5 related galleries by refering to gallery ID
HTTP request
GET /related/:id
Path parameters
| Parameter | Description |
|---|---|
| id | ID of an hentai |
Response
Returns a 200 HTTP status code and a JSON object with the following data.
| Property | Type | Description |
|---|---|---|
| response.data | IHentai[] | Array of related galleries |
{
"status": "success",
"code": 201,
"response": {
"message": "related gallery obtained",
"data": [
{
"id": 138020,
"media_id": "829651",
"title": {
"japanese": "(100) [JUNKLAND2 ()] () []",
"pretty": "Yokushitsu no Igyou",
"english": "(COMITIA100) [JUNKLAND2 (Shimimaru)] Yokushitsu no Igyou (Ichi) [Decensored]"
},
"images": {
"cover": {
"h": 497,
"t": "j",
"w": 350
},
"pages": [
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
},
{
"h": 1705,
"t": "j",
"w": 1200
}
]
},
"tags": [
{
"id": 33172,
"name": "doujinshi",
"type": "category"
},
{
"id": 6346,
"name": "japanese",
"type": "language"
},
{
"id": 32224,
"name": "eggs",
"type": "tag"
},
{
"id": 30083,
"name": "shimimaru",
"type": "artist"
},
{
"id": 29224,
"name": "impregnation",
"type": "tag"
},
{
"id": 28521,
"name": "voyeurism",
"type": "tag"
},
{
"id": 20035,
"name": "x-ray",
"type": "tag"
},
{
"id": 18567,
"name": "monster",
"type": "tag"
},
{
"id": 10314,
"name": "schoolgirl uniform",
"type": "tag"
},
{
"id": 9661,
"name": "cervix penetration",
"type": "tag"
},
{
"id": 8693,
"name": "uncensored",
"type": "tag"
},
{
"id": 8653,
"name": "netorare",
"type": "tag"
},
{
"id": 8378,
"name": "glasses",
"type": "tag"
},
{
"id": 7752,
"name": "schoolboy uniform",
"type": "tag"
},
{
"id": 2707,
"name": "junkland2",
"type": "group"
}
]
},
]
}
}