Common specifications for endpoints

Common specification

protocol

HTTPS is used for communication, HTTP is not available.

Character encoding

The character encoding for request and response is UTF-8.

Rate Limits

The limit on the number of requests that can be executed for each API is as follows.

Limit on the number of API requests
10,000/hour per user

Status Code

The following status codes are returned from the JINS MEME API.

Status codeDescription
200
ok
Request succeeded.
400
bad_request
Invalid request parameters were received. Please check if the parameters sent are in accordance with the specifications.
401
invalid_client
OAuth authentication failed. Please check the App ID and App Secret.
403
forbidden
You are not authorized to use the resource. Please check your App ID and App Secret.
404
not_found
The target resource could not be found.
409
conflict
Data update failed due to conflict with updated data. Please rerun.
429
too_many_requests
The maximum number of requests has been exceeded. Please reexecute after some time has elapsed.
500
internal_server_error
Internal server error.
503
server_unavailable
The server is temporarily under high load. Please wait some time and rerun.

Response Header

The JINS MEME API response includes the following HTTP headers.

Response HeaderDescription
X-RateLimit-LimitMaximum number of requests
X-RateLimit-RemainingRemaining Request Count
X-RateLimit-ResetReset time for request count limit (in epoch second format)

Error Responses

When an error occurs, a response body containing the following JSON data is returned.

PropertyDescription
errorError_name
error_descriptionDetailed error message

The following is an example of a JSON response when an error occurs.

{
  "error": "internal_server_error",
  "error_description": "Error Message."
}