what's in it for you in the OAuthentic API?
➀ Developer Dashboard
It is a new component of the web app open to any OAuthentic user who wants to use the API as individual or business user. When connected, see the Developer Dashboard button in the toolbar which leads to the following sections:
- Home: A few explanations about the dashboard and the API.
- Account: Some optional profile data and the IP addresses of servers that call the API.
- Services: The place where you define as many OAuthentication services as you want with their various properties (IP, webhook, biometric checking...).
- Logs: A simple tool to display logs of your services that you can also
get with the
/admin/log
endpoint.
➁ REST API
The REST API contains the following endpoints:
In addition to these endpoints, the OAuthentic API also includes some asynchronous notification mechanisms based on both websocket (client side) and webhook URL (server side). See the video below and the OAuthentic GitHub repo for further details.
➂ Open Source Libraries
A couple of open source libraries (MIT licence) are provided in the OAuthentic GitHub repo to integrate the OAuthentic API like a breeze.
- PHP client: It is a small utility for server side token creation and its transmission to client side.
- JavaScript client: This library takes care of the sequence of operations
and QR-code display for HTML/JavaScript integration. Especially it includes websocket communication
with the OAuthentic API servers (
api.oauthentic.com
andsocket.oauthentic.com
). Websockets are not mandatory to make the magic happen (webhooks are fine too), but they are convenient to follow the asynchronous authentication progress. This library requires the Socket.io client 2.1.1.
For issues and requests, please use the GitHub repo.