Biometric APIs

API Endpoint
https://indiaapi.adda.io

HTTP Methods

This API uses HTTP verbs (methods) as following:

  • GET - Read - used to read (or retrieve) a representation of a resource,

  • POST - Create - used to create new resources. In particular, it"s used to create subordinate resources.

Media Type

Where applicable this API MUST use the JSON media-type. Requests with a message-body are using plain JSON to set or update resource states.

Content-type: application/json and Accept: application/json headers SHOULD be set on all requests if not stated otherwise.

Status Codes and Errors

This API uses HTTP status codes to communicate with the API consumer.

  • 200 OK - Response to a successful GET, PUT, PATCH or DELETE.

  • 404 Not Found - When a non-existent resource is requested.

  • 500 Device not added yet - Device not added to ADDA database yet.

Biometric Apis

Request Post check in/out form device

POST https://indiaapi.adda.io/api/biometric/event?SN=CSADFSD12ASDD&Stamp=9999
Responses200404500
Headers
Content-Type: text/html; charset=UTF-8
Body
Ok
Headers
Content-Type: text/html; charset=UTF-8
Body
Nok
Headers
Content-Type: text/html; charset=UTF-8
Body
Nok

Request Post check in/out form device
POST/api/biometric/event{?SN}{&Stamp}

Store biometric staff event logs on server

Payload format: Multiline comma and tab separated values as show below

staff_badge,   check_in_out_time,     verify_status
staff_badge,   check_in_out_time,     verify_status
...
Parameter Description
check_in_out_time Datetime(format: YYYY-MM-DD H:M:S)(eg: 2020-06-23 20:28:40)
staff_badge Staff identifier/ ID card number
verify_status Check in / out
URI Parameters
HideShow
SN
string (required) Example: CSADFSD12ASDD
Stamp
string (required) Example: 9999

Status check

GET https://indiaapi.adda.io/api/biometric/ping?SN=CSADFSD12ASDD&Stamp=9999
Responses200404500
Headers
Content-Type: text/html; charset=UTF-8
Body
Ok
Headers
Content-Type: text/html; charset=UTF-8
Body
Nok
Headers
Content-Type: text/html; charset=UTF-8
Body
Nok

Status check
GET/api/biometric/ping{?SN}{&Stamp}

This is used to provide the status of Device to Server.

URI Parameters
HideShow
SN
string (required) Example: CSADFSD12ASDD
Stamp
string (required) Example: 9999

Generated by aglio on 04 Jul 2024