Responses Generated by Gateway

For some API requests, the response body is created by the gateway. This is usually the case in error situations or changing the response generated by the actual API server.

A header is sent through which you can check whether a request was generated by the gateway. If the response headers contain the following header, this indicates that the request was created by the gateway:

X-Jojapi-Gateway-Response: true

Let’s examine the responses generated by the gateway.

Error Messages

Error messages contain a message. An example response is like this:

{"message":"Invalid Server"}

Below is a list of error messages:

  • Invalid Server: Status code is 400. Indicates that you sent the request to the wrong gateway address.
  • Invalid URL: Status code is 400. Indicates that you sent the request to the wrong gateway URL.
  • Invalid Path: Status code is 400. Indicates that you sent the request to the wrong gateway path.
  • Invalid Endpoint: Status code is 400. Indicates that you sent the request to the wrong gateway endpoint.
  • Unauthorized: Status code is 401. Indicates that you are sending an unauthorized request. You must include the API key in your request.
  • Invalid API Key: Status code is 401. Indicates that you sent an invalid API key. Check that you sent a valid API key.
  • Subscription Not Found: Status code is 401. Indicates that you have no active subscriptions for the current API. Please check if you have a valid subscription.
  • Not Enough Credits: Status code is 402. Indicates that the credits on your API plan have been exhausted. You may consider renewing your plan or upgrading to a higher plan.
  • Insufficient Balance: Status code is 402. Indicates that you do not have sufficient funds to fulfill the request. You may consider adding balance to your account.
  • Your API Key is not available on this API: Status code is 403. It indicates that the API key you are using is restricted for the API to which you are sending the request.
  • User Blocked: Status code is 403. Indicates that your account is blocked.
  • Not Found: Status code is 404. Indicates that you sent a request to an address that does not exist.
  • API Not Found: Status code is 404. Indicates that you are sending a request to an API address that does not exist.
  • Endpoint Not Found: Status code is 404. Indicates that you are sending a request to an endpoint address that does not exist.
  • Method Not Allowed: Status code is 405. Indicates that you are sending an unsupported request method. The gateway currently only supports GET, POST, PUT, PATCH, DELETE methods.
  • API Gateway Error: Status code is 500. Indicates that the API provider does not configure the API.
  • Server Timeout: Status code is 500. Indicates that the API request has timed out. Currently the gateway supports a maximum delay of 90 seconds.
  • Server Error: Status code is 500. Indicates that an unknown error has occurred due to the target API server.
  • Invalid Response Code: Status code is 500. Indicates that the target API server returned an unsupported response status code.
  • Bad Response: Status code is 500. Indicates that the target API server returned an unsupported response body.
  • Target Server Error: Status code is 500. Indicates that the target servers specified by the API provider are invalid.

Related Posts