Common use cases

3rd Party Native App

10min

To set up your own third party native app to use AIQ for sales and marketing, you'll need to follow these steps:

1. Register Your App with AIQ

  1. Contact AIQ Support: Reach out to AIQ to get your app registered. They will provide you with the necessary credentials and API keys.

2. Get API Credentials

  • API Key: This is essential for authenticating your app's requests to the AIQ endpoints.
  • Secret Key: This will be used along with your API key for secure communication.

3. Set Up the API Environment

  1. Create API Endpoints: Use AIQ’s API documentation to understand the endpoints available for integration.
  2. Authentication: Set up authentication using the provided API and Secret Keys.

4. Integrate with AIQ Endpoints

AIQ provides various endpoints for managing sales, marketing, and customer data. Here are some of the key endpoints:

Add/Update Customer: Use this endpoint to add new customers or update existing customer details.

Loading...



Submit Sales Data: Use this endpoint to push sales data to AIQ.

Loading...



Create Campaign: Use this endpoint to create a new marketing campaign.

Loading...



Opt-Ins: Use this endpoint to set push notifications opt-in status for contactIDs. This does not send any opt-in requests.

Make sure that you are not breaking the law when using this endpoint and only using it as described in this document.

Loading...



5. Build Your Native App

  1. Front-End Integration: Use the API endpoints to integrate AIQ’s features into your app’s UI. For example, show customer loyalty points, display personalized offers, etc.
  2. Backend Processing: Ensure your backend system processes API calls to and from AIQ, managing customer data, sales transactions, and marketing campaigns.

6. Testing and Deployment

  1. Test End-to-End Flow: Make sure to thoroughly test all integrations in a staging environment before moving to production.
  2. Monitor and Optimize: After deployment, continuously monitor the API usage and app performance. Use AIQ’s analytics to optimize your marketing strategies and sales processes.

Example Code Snippets

python

import requests url = "https://api.alpineiq.com/v1/customers" headers = { "Authorization": "Bearer your_api_key_here", "Content-Type": "application/json" } data = { "first_name": "John", "last_name": "Doe", "email": "[email protected]", "phone": "1234567890", "loyalty_member": True } response = requests.post(url, headers=headers, json=data) print(response.json())

javascript

const axios = require('axios'); const url = 'https://api.alpineiq.com/v1/sales'; const headers = { 'Authorization': 'Bearer your_api_key_here', 'Content-Type': 'application/json' }; const data = { customer_id: 'customer_id_here', total_amount: 100.0, items: [ { item_id: 'item_id_here', quantity: 2, price: 50.0 } ], transaction_date: '2024-06-03T12:34:56Z' }; axios.post(url, data, { headers: headers }) .then(response => { console.log(response.data); }) .catch(error => { console.error(error); });



Updated 14 Apr 2025
Doc contributor
Doc contributor
Doc contributor
PREVIOUS
Discounts
NEXT
POS Integration Tiers
Docs powered by Archbee