API Documentation (1.0)

Download OpenAPI specification:Download

Posts @epicmaxim.net

Attachments

Create attachment

Creates an attachment

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

location	string
originalHeight	integer
originalWidth	integer
type	string

Responses

Request samples

Payload

Content type

application/json

{"location": "string",
"originalHeight": 0,
"originalWidth": 0,
"type": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Update attachment

Update an attachment

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

attachmentId	integer
postId	integer

Responses

Request samples

Payload

Content type

application/json

{"attachmentId": 0,
"postId": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Posts

Update a post

Updates a post

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

id	integer
text	string

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"text": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Follow a user

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

followUserId

integer

Responses

Request samples

Payload

Content type

application/json

{"followUserId": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Create a post

Creates a post

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

originalPostId	integer
repostPostId	integer
text	string

Responses

Request samples

Payload

Content type

application/json

{"originalPostId": 0,
"repostPostId": 0,
"text": "string"
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Bookmark a post

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

postId

integer

Responses

Request samples

Payload

Content type

application/json

{"postId": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Delete a post

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

postId

integer

Responses

Request samples

Payload

Content type

application/json

{"postId": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

Like a post

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Request Body schema: application/json

Entity

postId

integer

Responses

Request samples

Payload

Content type

application/json

{"postId": 0
}

Response samples

200

Content type

application/json

{"message": "string",
"status": "string"
}

View post

Output post using id and username

query Parameters

id	integer Example: id=30 int
username	string Example: username="someusername" string

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"data": [{"attachments": [{"location": "string",
"originalHeight": 0,
"originalWidth": 0,
"type": "string"
}
],
"badges": ["string"
],
"bookmarked": true,
"bookmarks": 0,
"createdAt": "string",
"id": 0,
"liked": true,
"likes": 0,
"name": "string",
"photo": "string",
"replies": 0,
"repost": {"badges": ["string"
],
"createdAt": "string",
"id": 0,
"name": "string",
"photo": "string",
"text": "string",
"updatedAt": "string",
"userID": 0,
"username": "string"
},
"reposted": true,
"reposts": 0,
"text": "string",
"updatedAt": "string",
"userID": 0,
"username": "string",
"views": 0
}
],
"status": "string",
"total": 0
}

View posts

Output posts using certain criteria

query Parameters

search	string Example: search="sometext" string
limit	integer Example: limit=30 int
offset	integer Example: offset=10 int
originalPostId	integer Example: originalPostId=123 int
bookmarked	string Example: bookmarked="true" string
following	string Example: following="true" string
liked	string Example: liked="true" string
photos	string Example: photos="true" string
mentions	string Example: mentions="username" string

header Parameters

X-Auth-Token

string

Example: 8dd81ef52f1f2b1cc6af0d7dd9930499

Session Token

Responses

Response samples

200

Content type

application/json

{"data": [{"attachments": [{"location": "string",
"originalHeight": 0,
"originalWidth": 0,
"type": "string"
}
],
"badges": ["string"
],
"bookmarked": true,
"bookmarks": 0,
"createdAt": "string",
"id": 0,
"liked": true,
"likes": 0,
"name": "string",
"photo": "string",
"replies": 0,
"repost": {"badges": ["string"
],
"createdAt": "string",
"id": 0,
"name": "string",
"photo": "string",
"text": "string",
"updatedAt": "string",
"userID": 0,
"username": "string"
},
"reposted": true,
"reposts": 0,
"text": "string",
"updatedAt": "string",
"userID": 0,
"username": "string",
"views": 0
}
],
"status": "string",
"total": 0
}

API Documentation (1.0)

Attachments

Create attachment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Update attachment

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Posts

Update a post

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Follow a user

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Create a post

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Bookmark a post

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Delete a post

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Like a post

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

View post

query Parameters

header Parameters

Responses

Response samples

View posts

query Parameters

header Parameters

Responses

Response samples

Health

Health check

Responses

Stats

Stats

Responses