What does API error mean?

CORE is an API-centric web application. Any actions you perform in CORE are dependent on the responses to the API requests it sends to our API server. The server responds to an API request with a success code indicating the action is completed successfully. However, sometimes there may be no response or an error response. This indicates that the request has failed, and the action is not completed. In such cases, you may receive an API error message in CORE. There are many scenarios in which this can happen, but we can group them into two main categories:

  1. Temporary API errors: This category includes all those scenarios where the action you are trying to perform in CORE was previously executing successfully, but now it is failing to execute and returns an API error message. This can happen if there is a temporary issue with our servers and it is usually fixed promptly. For example, you may get an API error when trying to log in to CORE. In such scenarios, you should always start by checking our status page and see if any maintenance activities are going on. If you do not find anything on the status page, you should contact our Support team to find out the exact reason for the error.
  2. Permanent API errors: This category includes all those scenarios where the action you are trying to perform in CORE is not allowed by the APIs and, therefore, fails to execute. Usually, the API server responds to CORE with a specific error message that lets you know the exact reason for not allowing the action, e.g., You do not have the security permission to access this feature. Sometimes, the server may respond with a generic “API Error” message, and you may not know the exact reason due to which the action was not allowed. In such cases, you should contact our Support Team or post it on CORE Community. Someone will get in touch with you and let you know the exact reason for the error. This will also help us improve the error messaging in CORE and we may add a specific message in future updates.
Was this article helpful?
9 out of 39 found this helpful