API OpenDSR

Fluxo da solicitação do GDPR

Todos os tipos de solicitação do GDPR, acesso, portabilidade, exclusão e retificação possuem o mesmo fluxo:

1. O usuário do aplicativo envia uma solicitação.
2. O proprietário do aplicativo cria a solicitação GDPR (veja abaixo) e a envia para a AppsFlyer.
3. A AppsFlyer recebe a solicitação e responde com "201 OK" para solicitações válidas.
4. Durante as 48 horas seguintes, a solicitação fica na fila com o status  pendente. O usuário do aplicativo pode cancelar a solicitação. 
5. Após 48 horas, o status da solicitação muda para in_progress.A AppsFlyer envia um postback de alteração de status. Neste ponto, a solicitação não pode ser cancelada.
6. Em 14 dias (consulte a observação abaixo), a AppsFlyer atende à solicitação e o status da solicitação é atualizado para concluído. A AppsFlyer envia um postback de alteração de status.
   • Em caso de apagamento ou retificação, os dados do Usuário do Aplicativo são excluídos.
     
   • No caso de portabilidade ou acesso, os dados do usuário do aplicativo podem ser acessados no painel da AppsFlyer abaixo de GDPR ou por meio da API de solicitação (veja abaixo).

   Observação: este período de 14 dias começa assim que o período pendente de 48 horas termina. Assim, o prazo total para atendimento da solicitação é de 16 dias após o proprietário do aplicativo enviar a solicitação à AppsFlyer.

Formato da solicitação do GDPR

Uma API de solicitação do GDPR pode ser enviada por meio de HTTP POST ao seguinte endpoint:

https://hq1.appsflyer.com/api/gdpr/v1/opendsr_requests

Para a autorização da API, use o mesmo token da API V2 da Pull API. O usuário administrador recupera o token na página token da API no painel. Adicione o token no cabeçalho da solicitação da seguinte forma: 'Authorization': 'Bearer %AuthTokenV2%'

Parâmetros

Objetos Subject_identities

Exemplo: solicitação de exclusão do GDPR 

Exemplo de solicitação de apagamento para plataformas android, ios, web e windowsphone:

curl --location --request POST 'https://hq1.appsflyer.com/api/gdpr/v1/opendsr_requests' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer %AuthTokenv2% \
--data-raw '{ 
 "subject_request_id":"f4e5a271-f25e-4107-b681-************",
 "subject_request_type":"erasure",
 "submitted_time":"2020-07-05T10:00:00Z",
 "platform": "android",
 "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"
 ]
}'
 

Exemplo de solicitação de eliminação para plataformas CTV, PC e Console:

curl --location --request POST 'https://hq1.appsflyer.com/api/gdpr/v1/opendsr_requests' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer %AuthTokenv2% \
--data-raw '
{"requester": "test@email.com",
"subject_request_id":"valid-uuid4-string",
"subject_request_type":"erasure",
"submitted_time":"2020-07-05T10:00:00Z",
"subject_identities":[ 
 { 
  "identity_type":"appsflyer_id",
  "identity_value":"valid-appsflyer-id-string",
  "identity_format":"raw"
 }
],
"api_version":"0.1",
"property_id":"app-id",
"platform": "roku",
"status_callback_urls":[ 
 "https://examplecontroller.com/opengdpr_callbacks"
 ]
}'

Exemplo de código da solicitação de apagamento do 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\": \"\"," +
  "\r\n\"subject_request_type\": \"erasure\"," +
  "\r\n\"platform\": \"android\"," +
  "\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\": \"\"," +
  "\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/api/gdpr/v1/opendsr_requests/opendsr_requests")
  .post(body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Accept", "application/json")
  .addHeader("Authorization: Bearer", "")
  .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",
 "Authorization: Bearer": ""
}

body = {
 "subject_request_id": "", 
 "subject_request_type": "erasure", 
 "submitted_time": "2018-10-02T15:00:00Z",
 "platform": "android", 
 "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/api/gdpr/v1/opendsr_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/api/gdpr/v1/opendsr_requests',
 headers: 
 { Accept: 'application/json',
  'Content-Type': 'application/json',
  'Authorization: Bearer': '' },
 body:
 { subject_request_id: '',
  subject_request_type: 'erasure',
  submitted_time: '2018-10-02T15:00:00Z',
  platform: 'android',
  subject_identities: 
  [ { identity_type: 'android_advertising_id',
   identity_value: '',
   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/api/gdpr/v1/opendsr_requests";
   var client = new RestClient(url);
   var request = new RestRequest(Method.POST);
   request.AddHeader("Content-Type", "application/json");
   request.AddHeader("Accept", "application/json");
   request.AddHeader("Authorization: Bearer", "")
   var body = "{\r\n\"subject_request_id\": \"\"," + 
    "\r\n \"subject_request_type\": \"erasure\"," + 
    "\r\n \"submitted_time\": \"2018-11-02T15:00:00Z\"," +
    "\r\n \"platform\": \"android\"," +
    "\r\n \"subject_identities\": [\r\n" +
    "{ \r\n \"identity_type\": \"android_advertising_id\"," +
    "\r\n \"identity_value\": \"\"," + 
    "\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);
 }
 }

Toda solicitação do GDPR enviada pode ter seu status consultado posteriormente, especificando o subject_request_id. Existem quatro tipos de status compatíveis:

1. pending - uma solicitação correta foi recebida e está atualmente na fila
2. in_progress - uma solicitação está sendo executada no momento
3. completed - uma solicitação foi atendida
4. cancelled - uma solicitação foi cancelada

Formato da solicitação de status

Uma solicitação de status pode ser enviada por meio de HTTP GET ao seguinte endpoint:

https://hq1.appsflyer.com/api/gdpr/v1/opendsr_requests/<req_id>

Exemplo da resposta de 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",
}

Postbacks de status

Conforme descrito no Fluxo da solicitação do GDPR acima, quando o status de uma solicitação do GDPR é alterado, de pending para in_progress para completed, a AppsFlyer envia um postback do GDPR aos endpoints solicitantes, especificados com a propriedade status_callback_urls.

Exemplo de postback de status:

POST /opengdpr_callbacks HTTP/1.1
Host: examplecontroller.com
Content-Type: application/json
X-OpenGDPR-Processor Domain: gdpr.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"
}

Depois que uma solicitação de acesso ou solicitação de portabilidade for concluída, você poderá baixar o relatório via HTTP GET para o seguinte endpoint:

https://hq1.appsflyer.com/api/gdpr/v1/download/[REQUEST_ID]

O relatório gerado fica disponível durante catorze dias a partir do momento da conclusão.

Para conhecer os formatos compatíveis com a AppsFlyer, uma solicitação de descoberta pode ser enviada por meio de HTTP GET ao seguinte endpoint:

https://hq1.appsflyer.com/api/gdpr/v1/discovery

Exemplo da resposta de descoberta

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

É possível cancelar uma solicitação do GDPR, com base em seu subject_request_id, mas somente durante a fase pending.

Para enviar um HTTP DELETE com subject_request_id:

https://hq1.appsflyer.com/api/gdpr/v1/opendsr_requests/<req_id>

Resposta de cancelamento

Quando uma solicitação de cancelamento do GDPR é recebida, a AppsFlyer retorna uma resposta HTTP com código de status 202 e diversos outros parâmetros.

Depois que o cancelamento da solicitação ocorre, a AppsFlyer envia um postback com o status cancelado.

Esta API da AppsFlyer é uma API de teste para a API de Solicitações GDPR da AppsFlyer.

Como ela funciona?

Essa API de teste funciona da seguinte forma:

1. Assim que uma solicitação do GDPR for feita, a solicitação é colocada imediatamente no status "Pending". Para fins de teste, o status é alterado a cada 30 segundos.

2. Se um endpoint para um postback de status foi inserido na solicitação do GDPR, um primeiro postback é enviado logo após a solicitação e dois outros postbacks de status são enviados em intervalos de 30 segundos.

Ponto final de teste de solicitação do GDPR: POST

https://hq1.appsflyer.com/api/gdpr/v1/stub

Ponto final de teste da solicitação de status: GET

https://hq1.appsflyer.com/api/gdpr/v1/stub/:requestId

Ponto final de teste da solicitação de descoberta: GET

https://hq1.appsflyer.com/api/gdpr/v1/stub/discovery

Ponto final de teste da solicitação de cancelamento: DELETE

https://hq1.appsflyer.com/api/gdpr/v1/stub/:requestId

Ponto final de teste de certificado: GET

https://hq1.appsflyer.com/api/gdpr/v1/stubcertificate

Ponto final de teste de relatórios de acesso/portabilidade: GET

https://hq1.appsflyer.com/api/gdpr/v1/stub/download/:requestId

O usuário administrador da conta pode acessar as solicitações de GDPR enviadas no Painel de Registros.

Para solicitações de acesso e portabilidade completas, também é possível fazer download do relatório a partir deste painel.

Para acessar o Painel de Registros:

1. Acesse o painel principal e clique no seu nome de usuário.
2. Clique em Registros e a seguinte janela abrirá:

Os códigos de retorno e mensagens de erro de API de GDPR HTTP estão detalhados nesta seção. 

Códigos de retorno da API de GDPR

Código de retorno HTTP 400 - solicitação incorreta

Mensagens com código de retorno 400 contêm um JSON com o código de erro e mensagem.

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

Código de retorno 400 mensagens de erro na solicitação