Menerapkan OpenGDPR API

Alur Permintaan GDPR

Jenis-jenis permintaan GDPR, akses, portabilitas, penghapusan, dan koreksi, memiliki alur yang sama:

1. Pengguna Aplikasi mengajukan permintaan.
2. Pemilik Aplikasi membuat permintaan GDPR (lihat di bawah) dan mengirimkannya ke AppsFlyer.
3. AppsFlyer menerima permintaan tersebut dan memberi respons "201 OK" untuk permintaan yang valid.
4. Selama 48 jam berikutnya, permintaan ini menunggu giliran untuk diproses dan memiliki status tertunda. Pengguna Aplikasi dapat membatalkan permintaan tersebut. 
5. Setelah 48 jam, status permintaan berubah menjadi in_progress (dalam proses). AppsFlyer mengirimkan postingan balik (postback)'perubahan status’. Permintaan tersebut tidak dapat dibatalkan. 
6. a) Dalam 28 hari, AppsFlyer akan memenuhi permintaan tersebut.
   Dalam kasus penghapusan atau koreksi, data Pengguna Aplikasi dihapus.
   Dalam kasus portabilitas or akses, data Pengguna Aplikasi dapat diakses di AppsFlyer dashboard di bawah GDPR, atau via Request API (lihat di bawah).
   b) Status permintaan diperbarui menjadi selesai.  AppsFlyer mengirimkan postingan balik perubahan status .

Format Permintaan GDPR

GDPR Request API dapat dikirimkan via HTTP POST ke endpoint berikut ini - 

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

Token API adalah token API yang sama dengan yang digunakan untuk Pull API. Admin,  mengambil token Pull API dari halaman token API di Dasbor.  

Contoh permintaan penghapusan 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_url":"https://examplecontroller.com/opengdpr_callbacks",
 ]
}'
 

Contoh Kode Permintaan Penghapusan 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);
  }
 }
}

Setiap permintaan GDPR yang diajukan nanti akan dapat dilihat statusnya dengan menentukan subject_request_id. Ada empat jenis status yang tersedia:

1. pending - Permintaan valid telah diterima dan sedang dalam antrean
2. in_progress - Permintaan sedang diproses
3. completed - Permintaan telah diselesaikan
4. canceled - Permintaan telah dibatalkan

Format Permintaan Status

Permintaan dapat dikirimkan via HTTP GET ke endpoint berikut:

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

Contoh Respons Status

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 Status

Seperti dijelaskan pada Alur Permintaan GDPR di atas, saat status permintaan GDPR berubah, dari pending menjadi in_progress kemudian completed, AppsFlyer mengirimkan postback GDPR ke endpoint yang meminta, disertai dengan properti status_callback_urls.

Contoh Status Postback:

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"
}

Saat Permintaan Akses atau Permintaan Portabilitas selesai, Anda dapat mendownload laporan via HTTP GET ke endpoint berikut:

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

Laporan yang dihasilkan akan tersedia selama empat belas hari dari waktu penyelesaian.

Untuk mempelajari format yang didukung oleh AppsFlyer, permintaan keterangan dapat dikirimkan via HTTP GET ke endpoint berikut:

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

Contoh Respons Keterangan

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"
}

Anda dapat membatalkan permintaan GDPR, berdasarkan  subject_request_id, tetapi hanya selama fase pending . 

Untuk melakukan itu, kirimkan HTTP DELETE dengan subject_request_id ke:

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

Respons Pembatalan

Saat permintaan pembatalan GDPR diterima, AppsFlyer akan mengembalikan respons HTTP dengan kode status 202 dan beberapa parameter lainnya.

Setelah pembatalan permintaan diproses, AppsFlyer mengirimkan postback dengan status cancelled . 

API AppsFlyer ini adalah API pengujian untuk Requests GDPR API AppsFlyer. 

Bagaimana Cara Kerja API ini?

API pengujian bekerja seperti berikut:

1. Setelah permintaan GDPR dibuat, permintaan tersebut langsung mendapat status ‘Pending’. Untuk tujuan pengujian, status berubah setiap 30 detik.

2. Jika endpoint untuk postback status telah disertakan ke dalam permintaan GDPR, postback pertama akan dikirim segera setelah permintaan dan dua postback status tambahan akan dikirim dalam interval waktu 30 detik.

Endpoint Pengujian Permintaan GDPR:

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

Endpoint Pengujian Permintaan Status:

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

Endpoint Pengujian Permintaan Keterangan:

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

Endpoint Permintaan Pembatalan:

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

Admin akun dapat mengakses permintaan GDPR yang diajukan di Dashboard Log.

Laporan permintaan akses dan portabilitas lengkap juga dapat didownload dari dashboard ini.

Untuk mengakses Log Dashboard:

1. 1.  Buka dashboard utama dan klik nama user anda.
2. Klik Log dan jendela berikut dibuka:

Kode pengembalian HTTP API GDPR dan pesan kesalahan dirinci dalam sesi ini. 

Kode pengembalian kode 400 - bad request

Pesan yang memiliki kode 400 berisi JSON dengan kode dan pesan kesalahan.

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