Getting Started

This guide will help you quickly start using our REST API for managing customer data. Learn how to set up, authenticate, and make your first API calls, enabling you to manage user profiles, log events, and harness the full power of our Customer Data Platform.

With NotifyVisitors API, you can -
Track users and their event activities
Send personalized campaigns to each user for Push, Email, SMS
Schedule one time campaigns to targeted segments for Push, Email, SMS
Retrieve reports for all your campaigns

API Authentication

NotifyVisitors requires a Brand ID and API Key to be included in the header of each API call. Each NotifyVisitors account is automatically assigned a unique REST API key, which remains valid for the account's entire lifetime.
If your API key is accidentally compromised or shared with a third party, you can generate a new key and deactivate the compromised one from the Store Integration section.

NotifyVisitors provide the endpoints along with the specific requirements which perform these actions that mean returns the data. With the help of this data, you can easily track the actions performed by the users along with data associated.

{{Example Code}}

ACCESS THE NOTIFYVISITORS API

• Login to the NotifyVisitors account.

• Navigate to the Profile > INTEGRATION

curl --request POST \
  --url https://analytics.notifyvisitors.com/api/v1/user/create \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-brand-id: YOUR_BRAND_ID' \
  --data '{"nv":[{"userID":"1234"",user_attributes":{name:'John', email:'[email protected]', mobile:'+919899999999'
  }}]}'

📘

Note:

Getting API Key

• Login to the NotifyVisitors account.

• Navigate to the Settings > STORE INTEGRATION section

> 📘 - Replace YOUR_API_KEY with NotifyVisitors' API key.

• Replace YOUR_BRAND_ID with NotifyVisi

API Authentication for Partner Apps

As a Partner App, when a client grants access to the NotifyVisitors API, an access token is returned. This token must be included as an authorization bearer token in the header of each API call.

curl --request POST \
  --url https://analytics.notifyvisitors.com/api/v1/user/create \
  --header 'content-type: application/json' \
  --header 'Authorization: Bearer ACCESS_TOKEN' \
  --data '{"nv":[{"userID":"1234"",user_attributes":{name:'John', email:'[email protected]', mobile:'+919899999999'
  }}]}'

NOTIFYVISITORS API ENDPOINT

You can access all the resources available via API over the HTTPS server. Whenever an API requests to access data from a web application or server, a response is always sent back.

ACCESS DATA VIA API

You can send and receive the data by calling on the below API Endpoints.

• You can call the below Endpoint for collecting and sending data regarding the push notifications.
  https://push.notifyvisitors.com/api/v1/

• You can call the below endpoint for for adding users and events to NotifyVisitors.
  https://analytics.notifyvisitors.com/api/v1/

API RATE LIMIT

• The API rate limit is the number of time the API can be requested per minute.
• You can make up to 500 API requests per minute on an API.
• If the limit exceeds, the app will throw error in Response. All API requests are subject to rate limits.

📘

CONTACT SUPPORT :

If you want to exceed the API limit, feel free to contact us on [email protected]

HOW TO SEND THE DATA

• You can send the data in JSON format.

• You can send the data by passing the Format parameter in the URL as JSON.

• You can pass any parameters as HTTP query string parameters in the API URLs.

WHAT IS THE DATE FORMAT

The timestamps for the data will be in the following format :

📘

yyyy-MM-ddTHH:mm:ss

2013-01-26T07:31+0000

HOW TO RECEIVE THE API RESPONSE

API Response is usually received in the following format or container: i.e. response.

This API response has the following properties:

Status: It will either be shown as an error as success depending upon the response of the server.

Data: It will contain the data for the requested resource.

Message: The said property will determine the reason for the corresponding status.

{
    "response" : {
        "data" : {
            ...
        },
        "message" : "success",
        "status" : "success"
    }
}

HOW TO GET API CREDENTIALS

• Login to the NotifyVisitors account.

• Navigate to the Profile > STORE INTEGRATIONtors' Brand id .

ERRORS

An HTTP response code of 429 would be sent if you exceed these limits.
You will also get the following headers in the response for you to programmatically keep a track of the limits: