LogoLogo
WebsiteGuide & TutorialBlogBook a Demo
1.0.0
1.0.0
  • Acquire Developers Hub
  • Acquire
    • Acquire Build Requirement
      • Requirement For Acquire
      • Acquire Speedtest
  • JS API
    • JS Live Chat API
      • Description
      • Installation
      • Visitor
      • Thread
      • Conversation
      • User Verification
    • Quick Link Support
      • One Click Button
      • Social Media Share
    • Backend JS SDK
      • Setup Backend JS SDK
      • Demo Backend SDK
    • Advanced
      • Widget UI
      • Reference
  • Co Browse APIs
    • Acquire Co Browse
      • Co Browse API
  • Acquire API Events
    • WebRTC Related Events
  • iOS
    • SDK Setup Guide
      • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Manual Setup iOS
      • Acquire Account ID
    • SDK Configuration Example
    • iOS Cobrowse
    • Theme Setting
    • iOS Push Notifications
    • Verify your users
  • Android
    • Getting Started
      • Integration Guide (Core)
      • Integration Guide (Lite)
      • Start using Acquire
    • Acquire APIs
    • Acquire Delegates
    • Custom UI/widget
    • Cross Platform Integrations
  • Webhook API
    • Webhooks Basic
      • Introduction
      • Webhook Integrate Steps
      • Webhook Format
    • Webhook Events
      • On Chat Start
      • On Chat Accept
      • On Chat Message
      • On Chat Close
  • REST APIs
    • OAuth
      • Authorization
      • Tracklog
    • Profiles API
      • Profile List
      • Thread
      • Feedback
      • Profile Details
      • Message
      • Tags
      • Profile Agents
      • Campaigns
      • Profile Add Update
      • Profile Delete
      • Profile Visit History
      • Sender Emails
    • Chat
      • Chat Notes
    • Analytics
      • Chat Statistics
      • Team Analytics
      • Conversion Rate
      • Chat Tag
      • Co browsing
    • Agent
      • Agents List
      • Agent add
      • Edit / Get-agent
      • Update
    • Trigger
      • Triggers List
      • Triggers Detail
    • Operating Hours
      • Save Operating Hours
      • Get Operating Hours
    • Cobrowse
  • Chatbot API
    • Chat Bot
      • Integrate Your Chatbot
      • Dialog Flow V1 Chat-Bot
      • Dialog Flow V2 Chat-Bot
      • Dialog Flow Fulfillment & Custom Response
      • IBM Watson Integration
      • Amazon Lex Bot
      • Azure's QnA Maker
      • Webhook Calling & User Verification
      • Webhook For Reset Password
  • Knowledge Base APIs
    • Help Docs Setup
      • Get FAQ Categories
      • Get Setup Details
      • Get Side List
      • Get Article
      • Get Recent Article
      • Get Categorized Articles
      • Get Suggestion
  • Errors
    • API Error Handling
      • HTTP Responses
Powered by GitBook
On this page
  1. REST APIs
  2. OAuth

Authorization

PreviousOAuthNextTracklog

Last updated 5 years ago

Welcome to the Acquire Developer Docs. Whether you're looking to use our REST APIs, receive notifications with webhooks, or build an app for the Acquire , you've come to the right place.

To access the Acquire API, you'll need a token. The type of token you need depends on your use case:

  • Use Access Tokens if you're using the API to access data in your own Acquire workspace.

  • Use OAuth if you're building a publicly-available app that accesses other people's Acquire data.

Access tokens

You should use an Access Token if:

  • You want to use the API to interact with your own Acquire app

  • You have scripts to push or extract data from your Acquire app

  • You want to use the API to programmatically automate certain actions in your own Acquire app

  • The data you interact with programmatically is your own customer data

How to get an Access Token

We provide an Access Token as soon as you create an app on your workspace. First login Acquire dashboard and Go Setting > API Token and Whitelist > API Token ( ). Copy API token and use api header in auth_token parameter. If you want to new token generate click on button "Generate New Token".

Your Access Token can give access to your private Acquire data and should be treated like a password. If an app provider asks you for your Access Token, please do not provide it. Instead, let us know - apps are required to use OAuth rather than asking users for Access Tokens.

You should use OAuth if:

  • You are requesting access to other people's Acquire accounts/data (for example, through an integration you've built)

  • You currently ask people for their API Keys to request resources on their behalf

  • You want to make it easier for your customers to share their customers' data with you

Never ask users for their Access Token Asking your users for their Access Tokens rather than implementing OAuth is against our terms of service and may result in your API access being revoked.

How to use your Token

To use your Token, simply provide it as part of the authorization header when you make a request. Tokens use the bearer authorization header when you make a request. This just means you need to specify the bearer type in the header.

Sample Code

curl -X POST \
  https://app.acquire.io/profile/lead/list \
  -H 'Authorization: Bearer <API_AUTH_TOKEN>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
https://app.acquire.io/setting/token
Authorization API Token