This document describes the API that returns the status of the identity API.
Base URL
https://identity.cladfy.app/api/v1
Request Headers:
-
Content-Type:
"application/json"
Indicates that the data in the request body is in JSON format. -
Accept:
"application/json"
Tells the server that the client expects the response to be in JSON format. -
Authorization:
"Basic 123"
Used for HTTP Basic Authentication, where"123"
is a placeholder for the base64-encodedusername:password
credentials. See guide here
Response - 200:
The response will be a JSON object following the request data type specification: A typed dictionary containing the detailed results. Properties include:
-
success
- Type: boolean
- Required: Yes
-
response_code
- Type: integer
- Required: Yes
- Example:
200
-
message
- Type: string
- Required: Yes
- Example: "API service running okay"
-
request_ip
- Type: string
- Required: Yes
Example Response:
{
"success": true,
"response_code": 200,
"message": "API service running okay",
"request_ip": "string"
}
Error Handling:
401 Unauthorized: If the API key is invalid.
400 Bad Request: If the request body is not valid JSON or missing required fields.
500 Internal Server Error: If an internal server error occurs during API request processing. The response will include an error message.
Python Test Example:
This test example demonstrates sending a GET request to the API endpoint. The response will include the associated details.
import requests
url = "https://identity.cladfy.app/api/v1/"
headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Basic 123"
}
response = requests.get(url,headers=headers)
print(response.json())