Custom API Integration

You can seamlessly integrate miQey into your application with your own login page, without relying on our OpenID Connect service.

We offer a PHP package to simplify requesting Sign Requests and managing webhooks for authentication SMS. Alternatively, you can use our REST API to handle the entire process independently.

Integrate miQey in your app

Integrate with API (Manually)

Get a Sign Request

A Sign Request is initiated by your application to miQey to start the authentication process. The API call must include the api_key and optionally a custom_code to link the SMS to your request. If custom_code is not provided, miQey will generate a random code.

You can retrieve the Sign Request by making a POST call.

 POST https://app.miqey.com/api/generate

Parameters

api_key: required
custom_code: optional

The response to this API call will include the following data:

[
login_page: A URL to a miQey-provided login page. If your application doesn't have a login page, you can use this one.
code: The unique code to track authentication, which must be included in the SMS message.
phoneNumber: The phone number where the SMS should be sent.
fallbackNumber: An alternative phone number to use if authentication fails.
qr: A QR code containing SMS data. Scanning this code with a smartphone will create an SMS message.
base64Qr: A BASE64-encoded version of the QR code containing SMS data. Scanning it will create an SMS message.
ios: A link specifically designed for iOS devices that contains all necessary SMS data.
android: A link specifically designed for Android devices that contains all necessary SMS data.
]

User authentication with miQey Login Page

The provided Sign Request includes a link to the miQey login page.

For desktop users: Wrap the login_page link in a QR code that the visitor can scan with their smartphone.
For smartphone users: Embed the login_page link in a button for easy access.

Receiving a webhook on your endpoint

When the user sends an SMS to our service, we will confirm the authentication via a webhook on your eindpoint. The webhook will include the user's phone number and the code. At this point, you can proceed to authenticate your visitor.

Integrate using our Package