Swapping from v1 to v2

📘

Only API request format will change, and the response will remain exactly the same and backward compatible. No need to update your dashboards.

Basics

In the v1 API, each API user was automatically assigned a single API key, that was linked with the account.

In the v2 API, Account Owner or Admin may generate the custom token on the API management page in your AppFollow account.

Authentication to the API occurs using HTTP Headers. Provide your API token in the Header. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. You must authenticate for all requests.

What's new?

  1. The v1 API is located at https://api.appfollow.io, while the v2 API is located at https://api.appfollow.io/v2/.

  2. Authorization token should be added to the Header. Please refer to the Authorization section to read more.

curl -i -X GET \
'https://api.appfollow.io/api/v2/reviews?ext_id=606870241' \
-H 'X-AppFollow-API-Token: YOUR_API_TOKEN_HERE'
  1. Paths and HTTP methods for several endpoints were updated to make it more clear. Please refer to the Methods list to see the updated paths.

GET methods structure will remain the same, request parameters are in the query string

BEFORE:

curl -u YOUR_API_KEY_HERE:
'http://api.appfollow.io/reviews?ext_id=618783545'

AFTER:

curl -X GET \
  'https://api.appfollow.io/api/v2/reviews?ext_id=618783545' \
  -H 'X-AppFollow-API-Token: YOUR_API_TOKEN_HERE'

POST/PATCH/DELETE methods will require parameters in the request body

BEFORE:

curl -u YOUR_API_KEY_HERE:
'http://api.appfollow.io/reply?answer_text=Thanks!&ext_id=692885364&review_id=884964243'

AFTER:

curl -X POST \
  https://api.appfollow.io/api/v2/reviews/reply \
  -H 'Content-Type: application/json' \
  -H 'X-AppFollow-API-Token: YOUR_API_TOKEN_HERE' \
  -d '{
    "answer_text": "Thanks!",
    "ext_id": "692885364",
    "review_id": "884964243"
  }'