The HitMe API uses API keys to authenticate requests.

Your API keys are unique, be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.

Limitations

Maximum numbers of requests is limited to 5000 / hour, it's mean your key can be suspended for 24h if will be overused.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Public User Key:

Secret Key:

This is an example API key. The request will not work with this key. Please create an account to access live API keys.

Required attributes:

user_key (string)

All request to API require user access key.

secret_key (string)

For security reasons, the secret key should not be shown/shared publicly.

HitMe uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success.

Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted etc.).

Codes in the 5xx range indicate an error with HitMe's servers (these are rare).

Attributes:

code (string)

For some errors that could be handled programmatically, a short string indicating the error code reported.

message (string)

A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

This action allow to request data of specific post. Returned data will include simple post data with connected to it image file.

Required attributes:

method (string)

get

action (string)

post

postid (integer)

Unique post ID

This is an object representing a file hosted on HitMe servers. To get right file you need to use unique id which is connected with to the file.

All files are hosted on HitMe CDN server.

Required attributes:

method (string)

get

action (string)

file

postid (integer)

Unique file ID