

- Aircall knowledge base how to#
- Aircall knowledge base install#
- Aircall knowledge base code#
- Aircall knowledge base password#
Aircall knowledge base password#
The api_id is the username and the api_token is the password for each Public API requests. Public API requests must be authenticated using HTTP Basic Authentication. If you are building an App for several companies using Aircall, please refer to the OAuth section. In the API Keys section, click on Add a new API key and get your api_token and api_token.ĭo not forget to copy/paste your api_token somewhere safe, we won't be able to retrieve it for you as Aircall does not store it in plain text!
Aircall knowledge base how to#
Integrations can only be installed by users who are Admins on Aircall!Ĭheck out our Ruby example app on Github to better understand how to implement the Aircall OAuth flow!Īs an Aircall customer, an api_id and api_token are needed to use Aircall Public API: go to your Company's Settings page.
Aircall knowledge base install#
Start the instructions at Step 3 if you want to trigger the install flow directly from your interface and not from the Aircall Dashboard.

Aircall knowledge base code#
Partner ﹣ Web server receives the GET request on the redirect_uri route with the code query param….Once the Admin consented to the permissions the app is requesting ( scope=public_api), Aircall loads the redirect_uri URL with a code parameter. Only users who are Admins will be able to see this window, others will be redirected to the Download page. Aircall ﹣ Aircall then displays the authorization window.Partner ﹣ Once Step 2 is done, Web server redirects/forwards the request to the following Aircall URL:.This step is often used to display a custom Settings page, instructions on how to use the app and/or any useful information for the Admin. Partner ﹣ A Web server receives the GET request on the install_uri route.Aircall ﹣ When an Admin installs an App, a popup opens up and loads the install_uri URL.Read the OAuth flow first to understand what they are!

When signing up, an install_uri and a redirect_uri will be asked, make sure you have them ready. Contact us on we will get back to you shortly with those credentials! This parameter should be used for preventing Cross-site Request Forgery and will be passed back to you, unchanged, in your redirect_uri.īefore starting building the OAuth flow for your app, you will need to get OAuth client_id and client_secret from Aircall. Install one of many integrations built by our partners in our Marketplace! REST APIĪn optional string value created by your app to maintain state between the request and callback. Our Engineering team is on Twitter, follow them the Changelog if you've already implemented something based on previous versions of this documentation. Want to see an example of how easy it is to connect with Aircall Public API and Webhooks? Take a look at our tutorials! Webhooks provide great scalability to your application and only require to set up a public web server! see the Webhooks section for a complete list). We can call back any endpoint of your choice, each time an event occurs on an Aircall account (contact added, call created, user switched off. This service allows any developers to retrieve and manage Aircall data with HTTP requests. At Aircall, we are building the next-gen business phone system and we know that one of the best way to do that is to give you the ability to have the hands on Aircall features. Just like you, we are enthusiastic builders and we love to automate things.
