Triển khai API OpenGDPR

Quy trình yêu cầu GDPR

Các loại yêu cầu GDPR, quyền truy cập, tính khả chuyển, quyền xóa và hiệu chính, có cùng một luồng:

1. Người dùng Ứng dụng gửi yêu cầu.
2. Chủ sở hữu Ứng dụng tạo yêu cầu GDPR (xem bên dưới) và gửi đến AppsFlyer.
3. AppsFlyer  nhận được yêu cầu và trả lời là "201 OK" cho các yêu cầu hợp lệ.
4. Trong 48 giờ sau, yêu cầu được xếp hàng đợi và có trạng thái là đang chờ xử lý. Người dùng Ứng dụng có thể hủy yêu cầu. 
5. Sau 48 giờ, trạng thái yêu cầu sẽ thay đổi thành in-progress. AppsFlyer gửi postback 'thay đổi trạng thái'. Không thể hủy yêu cầu. 
6. a) Trong vòng 28 ngày, AppsFlyer sẽ hoàn thành yêu cầu.
   Trong trường hợp xóa hoặc hiệu chỉnh, dữ liệu của Người dùng Ứng dụng sẽ bị xóa.
   Trong trường hợp khả chuyển hoặc quyền truy cập, có thể truy cập dữ liệu của Người dùng Ứng dụng trong bảng điều khiển của AppFlyer theo GDPR hoặc thông qua API Yêu cầu (xem bên dưới).
   b) Trạng thái yêu cầu sẽ cập nhật thành hoàn thành. AppsFlyer gửi đăng lại thay đổi trạng thái.

Định dạng yêu cầu GDPR

API yêu cầu GDPR có thể được gửi qua HTTP POST tới điểm cuối dưới đây - 

https://hq1.appsflyer.com/gdpr/opengdpr_requests?api_token=[api token]

Mã thông báo API là cùng một mã thông báo API được sử dụng cho API Pull. Quản trị viên truy xuất mã thông báo API Pull từ trang mã thông báo API trong Bảng điều khiển.

Ví dụ yêu cầu xóa GDPR 

curl --location --request POST 'https://hq1.appsflyer.com/gdpr/opengdpr_requests?api_token=[api_token]' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{ 
 "subject_request_id":"f4e5a271-f25e-4107-b681-************",
 "subject_request_type":"erasure",
 "submitted_time":"2020-07-05T10:00:00Z",
 "subject_identities":[ 
  { 
   "identity_type":"android_advertising_id",
   "identity_value":"55*****-****-****-************",
   "identity_format":"raw"
  }
 ],
 "api_version":"0.1",
 "property_id":"com.*********.*******.********",
 "status_callback_urls":[ 
  "https://examplecontroller.com/opengdpr_callbacks"
 ]
}'
 

Ví dụ về mã yêu cầu xóa của GDPR

/* 
using the okhttp package install from maven
https://mvnrepository.com/artifact/com.squareup.okhttp3/okhttp
 */

import okhttp3.*;
import java.io.IOException;

public class GdprSendRequest {
 public static void main(String[] args){

  OkHttpClient client = new OkHttpClient();
  RequestBody body = RequestBody.create(null, "" +
  "{\r\n\"subject_request_id\": \"<SUBJECT_ID>\"," +
  "\r\n\"subject_request_type\": \"erasure\"," +
  "\r\n\"submitted_time\": \"2018-11-02T15:00:00Z\"," +
  "\r\n\"subject_identities\": [\r\n" +
  "{\r\n\"identity_type\": \"android_advertising_id\"," +
  "\r\n\"identity_value\": \"<ADVERTISING_ID>\"," +
  "\r\n\"identity_format\": \"raw\"\r\n}" +
   "\r\n]," +
   "\r\n\"property_id\": \"com.example.application\"}");

  Request request = new Request.Builder()
  .url("https://hq1.appsflyer.com/gdpr/opengdpr_requests?api_token=<API_TOKEN>")
  .post(body)
  .addHeader("Content-Type", "application/json")
   .addHeader("Accept", "application/json")
  .build();

  try {
   Response response = client.newCall(request).execute();
   System.out.println(response.code());
   System.out.println(response.body().string());
   System.exit(0);
  } catch (IOException e) {
   e.printStackTrace();
   System.exit(1);
  }
 }
}

""" using the requests python package, 
install using pip install requests """

import requests
import json
headers = {
 "Content-Type": "application/json",
 "Accept": "application/json"
}
params = {
 "api_token": ""
}
body = {
 "subject_request_id": "", 
 "subject_request_type": "erasure", 
 "submitted_time": "2018-10-02T15:00:00Z", 
 "subject_identities": [
  { "identity_type": "android_advertising_id", 
   "identity_value": "", 
   "identity_format": "raw" }
  ], 
 "property_id": "com.example.application" 
} 
body = json.dumps(body) 
res = requests.request("POST", 
"https://hq1.appsflyer.com/gdpr/opengdpr_requests", 
headers=headers, data=body, params=params) 
print(res.text) 
 

/* using the request npm package, 
install using npm install request */

var request = require("request");
var options = { method: 'POST',
 url: 'https://hq1.appsflyer.com/gdpr/opengdpr_requests',
 qs: { api_token: '' },
 headers: 
 { Accept: 'application/json',
  'Content-Type': 'application/json' },
 body:
 { subject_request_id: '<SUBJECT_ID>',
  subject_request_type: 'erasure',
  submitted_time: '2018-10-02T15:00:00Z',
  subject_identities: 
  [ { identity_type: 'android_advertising_id',
   identity_value: '<ADVERTISING_ID>',
   identity_format: 'raw' } ],
 property_id: 'com.example.application'
 },
 json: true };
request(options, function (error, response, body) {
 if (error) throw new Error(error);

 console.log(body);
});

using System;
using RestSharp;
namespace CS
{
 class Gdpr
 {
  static void Main(string[] args)
  {
		var url = "https://hq1.appsflyer.com/gdpr/opengdpr_requests";
		var apiToken = "?api_token=<API_TOKEN>";
  var client = new RestClient(url + apiToken);
  var request = new RestRequest(Method.POST);
  request.AddHeader("Content-Type", "application/json");
  Request.AddHeader("Accept", "application/json");
  var body = "{\r\n\"subject_request_id\": \"<SUBJECT_ID>\"," + 
   "\r\n \"subject_request_type\": \"erasure\"," + 
   "\r\n \"submitted_time\": \"2018-11-02T15:00:00Z\"," +
   "\r\n \"subject_identities\": [\r\n" +
   "{ \r\n \"identity_type\": \"android_advertising_id\"," +
   "\r\n \"identity_value\": \"<ADVERTISING_ID>\"," + 
   "\r\n \"identity_format\": \"raw\"\r\n }" + 
   "\r\n ]," + 
   "\r\n \"property_id\": \"com.example.application\"}";
		 
   request.AddParameter("undefined", body,ParameterType.RequestBody);
   IRestResponse response = client.Execute(request);
   // handle response by reading response.StatusCode
   Console.WriteLine(response.Content);
  }
 }
}

Mỗi yêu cầu GDPR đã gửi đi, sau này có thể được truy vấn về trạng thái của nó, bằng cách nêu rõ subject_request_id. Có bốn loại trạng thái được hỗ trợ:

1. đang chờ xử lý - Một yêu cầu chính xác đã được nhận và hiện đang xếp hàng đợi
2. in_progress - Yêu cầu hiện đang được thực hiện
3. đã hoàn thành - Yêu cầu đã được hoàn thành
4. đã hủy - Yêu cầu đã bị hủy

Định dạng yêu cầu trạng thái

Yêu cầu trạng thái có thể được gửi qua HTTP GET tới điểm cuối dưới đây:

https://hq1.appsflyer.com/gdpr/opengdpr_requests/[subject_request_id]?api_token=[api token]

Ví dụ về phản hồi trạng thái

HTTP/1.1 200 OK
Content-Type: application/json
X-OpenGDPR-Processor Domain: example processor.com
X-OpenGDPR-Signature:
kiGlog3PdQx+FQmB8wYwFC1fekbJG7Dm9WdqgmXc9uKkFRSM4uPzylLi7j083461xLZ+mUloo3tpsmyIZpt5eMfgo7ejXPh6lqB4ZgCnN6+1b6Q3NoNcn/+11UOrvmDj772wvg6uIAFzsSVSjMQxRs8LAmHqFO4cF2pbuoPuK2diHOixxLj6+t97q0nZM7u3wmgkwF9EHIo3C6G1SI04/odvyY/VdMZgj3H1fLnz+X5rc42/wU4974u3iBrKgUnv0fcB4YB+L6Q3GsMbmYzuAbe0HpVA17ud/bVoyQZAkrW2yoSy1x4Ts6XKba6pLifIHf446Bubsf5r7x1kg6Eo7B8zur666NyWOYrglkOzU4IYO8ifJFRZZXazOgk7ggn9obEd78GBc3kjKKZdwaCrLx7WV5y9TMDCf+2FILOJM/MwTUy1dLZiaFHhGdzld2AjbjK1CfVzyPssch0iQYYtbR49GhumvkYl11S4oDfu0c3t/xUCZWg0hoR3XL3B7NjcrlrQinB1KbyTNZccKR0F4Lk9fDgwTVkrAg152UqPyzXxpdzXjfkDkSEgAevXQwVJWBNf18bMIEgdH2usF/XauQoyrne7rcMIWBISPgtBPj3mhcrwscjGVsxqJva8KCVCKD/4Axmo9DISib5/7A6uczJxQG2Bcrdj++vQqK2succ=
{
 "controller_id":"example_controller_id",
 "expected_completion_time":"2018-11-01T15:00:01Z",
 "subject_request_id":"a7551968-d5d6-44b2-9831-815ac9017798",
 "request_status":"pending",
 "api_version":"0.1"
}

Postback trạng thái

Như được mô tả trong Quy trình Yêu cầu GDPR ở trên, khi trạng thái của yêu cầu GDPR thay đổi, từ pending thành in_progress thành completed, AppsFlyer gửi một postback GDPR tới các điểm cuối yêu cầu, được xác định với thuộc tính status_callback_urls.

Ví dụ về Postback Trạng thái:

POST /opengdpr_callbacks HTTP/1.1
Host: examplecontroller.com
Content-Type: application/json
X-OpenGDPR-Processor Domain: appsflyer.com
X-OpenGDPR-Signature: kiGlog3PdQx+FQmB8wYwFC1fekbJG7Dm9WdqgmXc9uKkFRSM4uPzylLi7j083461xLZ+mUloo3tpsmyIZpt5eMfgo7ejXPh6lqB4ZgCnN6+1b6Q3NoNcn/+11UOrvmDj772wvg6uIAFzsSVSjMQxRs8LAmHqFO4cF2pbuoPuK2diHOixxLj6+t97q0nZM7u3wmgkwF9EHIo3C6G1SI04/odvyY/VdMZgj3H1fLnz+X5rc42/wU4974u3iBrKgUnv0fcB4YB+L6Q3GsMbmYzuAbe0HpVA17ud/bVoyQZAkrW2yoSy1x4Ts6XKba6pLifIHf446Bubsf5r7x1kg6Eo7B8zur666NyWOYrglkOzU4IYO8ifJFRZZXazOgk7ggn9obEd78GBc3kjKKZdwaCrLx7WV5y9TMDCf+2FILOJM/MwTUy1dLZiaFHhGdzld2AjbjK1CfVzyPssch0iQYYtbR49GhumvkYl11S4oDfu0c3t/xUCZWg0hoR3XL3B7NjcrlrQinB1KbyTNZccKR0F4Lk9fDgwTVkrAg152UqPyzXxpdzXjfkDkSEgAevXQwVJWBNf18bMIEgdH2usF/XauQoyrne7rcMIWBISPgtBPj3mhcrwscjGVsxqJva8KCVCKD/4Axmo9DISib5/7A6uczJxQG2Bcrdj++vQqK2succ=

{
"controller_id":"example controller id at the processor",
"expected_completion_time":"2018-11-01T15:00:01Z",
"status_callback_url":"https://examplecontroller.com/opengdpr_callbacks",
"Subject_request_id":"a7551968-d5d6-44b2-9831-815ac9017798",
"Request_status":"pending"
}

Khi Yêu cầu Truy cập hoặc Yêu cầu Khả chuyển đã được hoàn tất, bạn có thể tải xuống báo cáo qua HTTP GET tới điểm cuối sau:

https://hq1.appsflyer.com/gdpr/download/[REQUEST_ID]?api_token=[TOKEN]

Báo cáo được tạo sẽ khả dụng trong mười bốn ngày kể từ thời điểm hoàn thành.

Để tìm hiểu về các định dạng được AppsFlyer hỗ trợ, có thể gửi yêu cầu phát hiện qua HTTP GET tới điểm cuối sau:

https://hq1.appsflyer.com/gdpr/discovery?api_token=[api token]

Ví dụ về yêu cầu phát hiện

HTTP/1.1 200 OK
Content-Type: application/json
{
 "api_version": "0.1",
 "supported_identities": [
 {
  "identity_type": "android_advertising_id",
  "identity_format": "raw"
 },
 ],
 "supported_subject_request_types": [
 "erasure", "access", "portability", "rectification"
 ],
 "processor_certificate": "https://exampleprocessor.com/cert.pem"
}

Có thể hủy yêu cầu GDPR, dựa trên subject_request_id, nhưng chỉ hủy được trong gia đoạn chờ xử lý.  

Để nộp một HTTP DELETE với subject_request_id tới:

https://hq1.appsflyer.com/gdpr/opengdpr_requests/[subject_request_id]?api_token=[api token]

Phản hồi Hủy

Khi nhận được yêu cầu hủy GDPR, AppsFlyer sẽ trả về phản hồi HTTP có mã trạng thái 202 và một số thông số khác.

Sau khi việc hủy bỏ yêu cầu diễn ra, AppsFlyer sẽ gửi một đăng lại với trạng thái đã hủy.

API này của AppsFlyer là một API kiểm tra của API Kiểm tra Yêu cầu GDPR. 

Nó hoạt động như thế nào?

API kiểm tra hoạt động như sau:

1. Sau khi yêu cầu GDPR được thực hiện, yêu cầu sẽ ngay lập tức được đặt vào trạng thái 'Đang chờ xử lý'. Để phục vụ mục đích kiểm tra, trạng thái này thay đổi sau mỗi 30 giây.

2. Nếu một điểm cuối cho một postback trạng thái đã được chèn vào yêu cầu GDPR, một postback đầu tiên được gửi ngay sau khi yêu cầu và thêm hai postback trạng thái được gửi sau 30 giây.

Điểm cuối Kiểm tra Yêu cầu GDPR:

https://hq1.appsflyer.com/gdpr/stub?api_token=[api token]

Điểm cuối Kiểm tra Yêu cầu Trạng thái:

https://hq1.appsflyer.com/gdpr/stub/[request id]?api_token=[api token]

Điểm cuối Kiểm tra Yêu cầu Phát hiện:

https://hq1.appsflyer.com/gdpr/stub/discovery?api_token=[api token]

Điểm cuối Kiểm tra Yêu cầu Hủy:

https://hq1.appsflyer.com/gdpr/stub/[request id]?api_token=[api token]

Quản trị viên tài khoản có thể truy cập các yêu cầu GDPR được gửi trong Bảng điều khiển Nhật ký.

Đối với các yêu cầu truy cập và khả chuyển đã hoàn tất, bạn cũng có thể tải xuống báo cáo từ bên trong bảng điều khiển này.

Để truy cập Bảng điều khiển Nhật ký:

1. 1.  Truy cập bảng điều khiển chính và nhấp vào tên người dùng của bạn.
2. Nhấp vào Nhật ký và cửa sổ sau đây sẽ mở ra:

Thông báo lỗi và mã trả về HTTP cho API GDPR được trình bày chi tiết trong phần này. 

Mã trả về HTTP 400 - lỗi yêu cầu

Thông báo có mã trả về là 400 có chứa JSON kèm theo mã lỗi và thông báo.

{ "error": { "Code":400, "af_gdpr_code": "%AF error code%", "message":"%error message text%" } }