The unique token can be extracted from the payload:Ĭonst webhookToken =
* Endpoint requested by Aircall as the first step of the Install flowĪpp.get('/aircall/oauth/install', (req, res) => )
Open your code editor and make sure to have a web server ready. Make sure you have them ready! 2 - Setup a Web serverĪircall will send Authentication requests to your server. Please contact us on create your OAuth application on Aircall, you will need to provide both an install_uri and a redirect_uri. Once redirected to your redirect_uri, you will need to exchange the OAuth authorization code for an access_token.Ī client_id and a client_secret are needed to use the OAuth flow. Use this step to get the OAuth authorization code. That's when Aircall redirects the Admin to your redirect_uri. Once redirected to Aircall, Admins will authorize your app to access their Aircall data.
This step is often used to display a Settings page, instructions on how to use the app, any useful information for the Admin.Įven it doesn't do anything specific, it must forward the user to. That's when Aircall redirects the Admin to your install_uri. The flow is started when Admins install an app from the Aircall Dashboard. Admins will consent your app to access their Aircall data. The goal of the OAuth flow is to get an access_token that will be used to authenticate each request you will do to Aircall Public API. If you want to see a practical example of how to implement the Aircall OAuth flow, check out our Ruby example app on GitHub! All the technical details are described in the API References, in the OAuth - Technology Partner section. This tutorial will guide you through the Aircall OAuth flow, and show you how it works in few steps. HTTP requests will be sent with an Authorization HTTP header, containing the word Basic, followed by a space and the Base64 encoded string api_id:api_token.įor example, if the api_id is 1234ABCD5678EFGH and the api_token is 9876LMNO5432PQRS, the string string to encode would be 1234ABCD5678EFGH:9876LMNO5432PQRS.If you are building an integration with Aircall that accesses Aircall's customers data, then you will need to set up OAuth and understand how that can be done with Aircall. Every request made must start with 3 - Create a Base64 encoded string with your API credentials Once generated and before closing the modal, copy and paste those credentials somewhere safe on your comcomputer! The api_token (= the password) will be presented to you only on API Key creation!Īircall Public API is protected behind SSL certificates. Aircall will generate two strings, representing the Basic Authentication username and password. In the API Keys section, click on Add a new API key. You can create some in your Company's Settings page.
Those username and password credentials are called api_id and api_token in the Aircall Dashboard. Basic Authentication follows this standard as well.
Lots of authentication methods require both a username and a password. 2 - Get your API ID and API Token credentials We will see in this tutorial how to send your first authenticated request to Aircall Public API. Lots of API communications are using it as it is one of the most easy-to-implement authentication method out there and yet really secure, both for the API provider and the API user.
Aircall implemented Basic Authentication, a simple and secure way to authenticate requests.īasic Authentication is a simple authentication standard, implemented in the HTTP protocol.