This documentation provides comprehensive guidance for integrating your QR code reader system with our Door Access Control API. This API is designed to verify the validity of QR codes presented by users and trigger the opening of physical doors when authentication is successful. Below, you'll find detailed instructions on how to invoke this API, including the required inputs and the expected responses.
API Endpoint
POST /api/door-access/
Base URL
https://api.oloidpreview.com
or Production domains
Authentication
This API requires an API key for authentication. Include your API key in the header of each request:
Authorization: Bearer <Your_API_Key>
Required Inputs
To invoke the API, you must provide the following information in the request body, formatted as JSON:
QR Code Data (
qrData): The data encoded in the QR code, typically a string.Door ID (
doorId): The unique identifier for the door that needs to be unlocked.Client Token (
clientToken): A token to verify the request's and client's authenticity.
Request Body Example:
{
"qrData": "encodedQRCodeData",
"doorId": "12345",
"clientToken": "secureclientToken"
}
Response
The API will respond with a JSON object containing the following fields:
status (
string): Indicates the result of the request, such asSuccessorFailure.message (
string): Provides additional information about the result, e.g., "Door opened successfully" or "Invalid QR code".
Success Response Example:
{
"status": "Success",
"message": "Door opened successfully"
}Failure Response Example:
{
"status": "Failure",
"message": "Invalid QR code"
}Error Handling
In case of errors, the API will return an appropriate HTTP status code and a message detailing the issue. Common errors include:
400 Bad Request: Missing or invalid input data.
401 Unauthorized: Invalid or missing API key.
403 Forbidden: The authentication token is invalid or expired.
404 Not Found: The specified Door ID does not exist.
500 Internal Server Error: Unexpected server error.
Integration Steps
Authentication: Ensure your system is capable of securely storing and transmitting the API key.
QR Code Reading: Implement functionality in your QR code reader to capture and encode the QR data.
API Invocation: Use the captured QR data, along with the Door ID and authentication token, to make a POST request to the API endpoint.
Response Handling: Based on the API response, take the appropriate action (e.g., unlock the door, display an error message).
Security Considerations
Always use HTTPS to encrypt data in transit.
Store the API key and authentication tokens securely.
Register Clients for endpoint security
Validate the QR code data before sending it to prevent injection attacks.
Support
For any issues or questions regarding this API, please contact our support team at support@oloid.ai.