Skip to main content

LOGIN

This API is used to authenticate the middleware layer and generate a admin_token required for accessing protected APIs.

🔑 Header Parameters

HeaderTypeDescriptionExample
Content-TypestringSpecifies request payload formatapplication/json
x-api-keystringAPI key for request authorization{{x-api-key}}

📑 Request Body Parameters

FieldTypeRequiredDescriptionExample / Enum
api_keystringYesAPI key provided by SynapseWave"xyz-api-key"
sourcestringYesSource application"WEBAPI", "MOBILEAPI"
versionstringNoApplication version"1.0.0"

🟢 Success Response - 200 OK

Content-Type: application/json

FieldTypeDescriptionExample
statusstringStatus of API call"success"
codestringResponse code"s-101"
messagestringSuccess message"Login session created successfully"
dataobjectLogin response payloadRefer Data Object Fields

📦 Data Object Fields

FieldTypeDescriptionExample
admin_tokenstringAuthentication token for subsequent APIs"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

📝 Notes

  • admin_token must be included in the Authorization header for all subsequent API calls: