API Health

---

 

On API Health, you can easily understand the health status of the API and its returned Status Codes.

To check the operational status of our service, you can use the following request. If the response you receive includes an HTTP status code of 200, it confirms the availability of your API.

   curl -X GET \
     'https://api.staging.ogaranya.com'

 

#Errors

The response body contains a JSON payload with additional information.

For example:

Here is the error you get when you are not authenticated:

  {
      "status":"Error",
      "message":"You don't come to a party without your Token and Public key",
   }

You get this when you make a call to an unavailable endpoint:

 {
      "status":"Error",
      "message":"This page is missing, so is Nigeria's budget
}

Anytime a wrong data type or unexpected data is sent, you get the below error:

  {
      "status":"Error",
      "message":"Invalid Parameter",
     "code":"E0001",
   }

When you call on a wrong or unavailable gateway:

    {
       "status":"Error",
      "message":" "We are not able to reach the gateway. We have reported this to the administrator. Please send your command again or use other payment gateway as stated below.\n\n",,
      "code":"E0024",
   }

When you input a wrong token,publickey or unauthurised:

  {
      "status":"Error",
      "message":" "I lost my glasses so I am finding it hard to find your credentials on the list of authorised users. Help look for my glasses.\n\n",,
      "code":"401",
   }