Reincubar o serviço de retransmissão

Sessões

Um processo de emparelhamento é usado para estabelecer um link entre um usuário da API e uma instância do aplicativo Reincubate Relay. Por padrão, se não estiver emparelhado, o Reincubate Relay exibirá seu código de emparelhamento. O usuário deve fornecer isso ao seu aplicativo para criar uma sessão válida, através da seguinte chamada.

curl https://ricloud-api.reincubate.com/sessions \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "source": {
    "user": "1",
    "type": "rirelay.instance"
  },
  "payload": {
    "code": "<Reincubate Relay pairing code>"
  }
}'

Depois que a sessão for criada, você poderá visualizar informações na instância do aplicativo por meio do atributo de source do objeto da sessão. Isso deve ser algo como isto:

{
  "id": "<session ID>",
  "resource": "session",
  ...
  "source": {
    "id": "<source ID>",
    "resource": "source",
    "user": "<user ID>",
    "type": "rirelay.instance",
    "identifier": "ee360f13-1b54-4d8c-8876-e5f573f0ba1c",
    "info": null,
    "parent": null,
    "children": {
      "data": [
        {
          "id": "<child source ID>",
          "resource": "source",
          "user": "<user ID>",
          "type": "rirelay.source",
          "identifier": "70a4982e-5893-4a5f-8af6-19db834d378d",
          "info": {
            "is_encrypted": true,
            "apple_model_id": "iPhone10,4",
            "apple_serial": "FFABCZGTJC12",
            "name": "iPhone 8",
            "ios_version": "13.2"
          },
          "children": {
            "data": [],
            "has_more": false,
            "total_count": 0,
            "url": "/sources/<child source ID>/children"
          },
          "state": "active",
          "date_created": "2019-10-08T09:02:15.770532Z"
        }
      ],
      "has_more": false,
      "total_count": 0,
      "url": "/sources/<source ID>/children"
    },
    "state": "active",
    "date_created": "2019-10-08T08:58:33.861941Z"
  },
  ...
}

Assinaturas

Diferentemente de outros serviços, é necessária uma assinatura para que a API possa começar a recuperar dados de uma origem do Reincubate Relay. Isso ajuda o usuário do aplicativo a entender exatamente quais dados estão sendo acessados.

As assinaturas só podem ser criadas com fontes do tipo rirelay.source , que são os filhos da instância Reincubate Relay. A sessão a ser usada ao pesquisar a fonte também deve ser especificada.

curl https://ricloud-api.reincubate.com/subscriptions \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "session": "<session ID>",
  "source": "<child source ID>",
  "poll_payload": {
    "data_types": ["ios_messages.messages"]
  }
}'

A assinatura permanecerá em um estado pendente até que o usuário permita o acesso ao dispositivo específico na interface do aplicativo Reincubate Relay. Uma vez permitido, o estado passará para active .

Uma pesquisa inicial é criada imediatamente na ativação da assinatura, e as pesquisas subsequentes serão criadas quando o aplicativo Reincubate Relay notificar a API sobre novos dados.

Pesquisas

As pesquisas também podem ser criadas manualmente em fontes com assinaturas ativas. Isso é útil ao solucionar problemas de dados recuperados ou ao testar novos tipos de dados.

curl https://ricloud-api.reincubate.com/polls \
  -X POST \
  -H 'Authorization: Token <your key_token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "subscription": "<subscription ID>",
  "payload": {
    "data_types": ["ios_phone.calls", "whatsapp.messages"]
  }
}'

Eventos

Para se manter informado sobre alterações assíncronas, como uma assinatura criando uma nova enquete ou uma sessão expirando, sua implementação precisará receber notificações de eventos da API por meio de um ponto de extremidade de webhook.

Para obter detalhes sobre como instalar e configurar o ponto de extremidade do webhook, consulte Configurando o webhooks .

Tipos de informação

O serviço Relay atualmente suporta apenas a recuperação de informações de rirelay.instance , que inclui informações aninhadas em quaisquer fontes rirelay.source

atributos rirelay.instance.info

atributos rirelay.source.info

atributos rirelay.source.info.info

Observe que name , ios_version , apple_model_id , apple_serial e is_encrypted , também estão incluídos nos dados de info aninhados Source e, portanto, podem ser acessados diretamente por meio de endpoints da API.

Para outros atributos, como phone_number , uma pesquisa completa para rirelay.instance.info é necessária - como este é informação pessoal não é armazenado pela API.

Tipos de dados

Reincubar tipos de dados do aplicativo de retransmissão

Reincubar tipos de dados agregados de retransmissão

Mensagens do iOS

Mensagens

Atributos de dados

Estende o tipo de dados da message .

Dados de amostra

{
  "id": "a1b2c3d4",
  "data_type": "message",
  "conversation_id": "w6x7y8z9",
  "handle": "vodafone",
  "type": "SMS",
  "text": "Hi from Vodafone!",
  "attachments": [],
  "group_handles": [
    "+441234567890",
    "renate@reincubate.com"
  ],
  "from_me": false,
  "deleted": false,
  "date": "2020-01-01T00:00:00.000000Z"
}

Contatos do iOS

Contatos

Atributos de dados

Estende o tipo de dados do contact .

Dados de amostra

{
  "id": "2cf6a837304d6614",
  "data_type": "contact",
  "first_name": "John",
  "middle_name": "'Gala'",
  "last_name": "Appleseed",
  "prefix": "Mr.",
  "suffix": "Jr.",
  "nickname": "John'o",
  "records": [
    {
      "type": "Phone",
      "name": "MAIN",
      "value": "1-800-MY-APPLE"
    },
    {
      "type": "Phone",
      "name": "UK",
      "value": "0800 039 1010"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com"
    },
    {
      "type": "URL",
      "name": "HOMEPAGE",
      "value": "http://www.apple.com/uk/"
    },
    {
      "City": "Cupertino",
      "State": "CA",
      "ZIP": "95014",
      "name": "WORK",
      "CountryCode": "US",
      "Country": "United States",
      "Street": "1 Infinite Loop",
      "type": "Address",
      "SubLocality": null,
      "Municipality": null
    }
  ],
  "organisation": "Apple Inc.",
  "department": "Marketing",
  "jobtitle": "VP Juicing",
  "birthday": "1976-04-01 00:00:00.000000Z"
}

Telefone iOS

Chamadas

Atributos de dados

Estende o tipo de dados da call .

Dados de amostra

{
  "id": "24116c5b16b85217",
  "data_type": "call",
  "call_type": "Phone",
  "address": "07123456789",
  "duration": 5.131359,
  "answered": false,
  "from_me": true,
  "date": "2015-07-20 10:23:27.538011"
}

Calendário do iOS

Eventos

Atributos de dados

Estende o tipo de dados do event .

Dados de amostra

{
  "id": "3",
  "unique_identifier": "f5fcf872-34f6-3f60-ba03-74d5a7a3bbbb",
  "calendar": "Home",
  "calendar_id": "477a2001537fe178d6b77cdceb8bac2e",
  "calendar_store": "Default",
  "summary": "Christmas Day",
  "description": "Bank holiday in the UK",
  "start_date": "2017-12-25T00:00:00.000000",
  "end_date": "2017-12-25T23:59:59.000000",
  "start_time_zone": None,
  "end_time_zone": None,
  "all_day": True,
  "travel_time": None,
  "recurrence": {
    "interval": 1,
    "repeat": "Yearly",
    "repeat_end_date": None,
    "specifier": ""
  },
  "location": None,
  "start_location": None,
  "attendees": ["John Appleseed"],
  "attached_url": None,
  "creation_date": None
}

Notas do iOS

Notas

Atributos de dados

Estende o tipo de dados da note .

Saúde do iOS

Dados associados ao aplicativo iOS Health e à estrutura HealthKit.

Dados

Atributos ios_health.profile

Amostra ios_health.profile

{
  "info_type": "ios_health.profile",
  "gender": "Female",
  "date_of_birth": "1988-08-22",
  "weight": 75.2543977,
  "height": 1.9812,
  "blood_type": "O+",
  "fitzpatrick_skin_type": "Type V"
}

Atributos ios_health.sample

Tipos de dados de integridade do iOS:

• ios_health.body_mass_index
• ios_health.body_fat_percentage
• ios_health.height
• ios_health.weight
• ios_health.lean_body_mass
• ios_health.heart_rate
• ios_health.steps
• ios_health.walking_running_distance
• ios_health.resting_energy
• ios_health.active_energy
• ios_health.flights_climbed
• ios_health.oxygen_saturation
• ios_health.blood_glucose
• ios_health.systolic_blood_pressure
• ios_health.diastolic_blood_pressure
• ios_health.blood_alcohol_content
• ios_health.peripheral_perfusion_index
• ios_health.total_fat
• ios_health.polyunsaturated_fat
• ios_health.monounsaturated_fat
• ios_health.saturated_fat
• ios_health.dietary_cholesterol
• ios_health.sodium
• ios_health.carbohydrates
• ios_health.fibre
• ios_health.dietary_sugar
• ios_health.dietary_energy
• ios_health.protein
• ios_health.vitamin_a
• ios_health.vitamin_b6
• ios_health.vitamin_b12
• ios_health.vitamin_c
• ios_health.vitamin_d
• ios_health.vitamin_e
• ios_health.vitamin_k
• ios_health.calcium
• ios_health.iron
• ios_health.thiamine
• ios_health.riboflavin
• ios_health.niacin
• ios_health.folate
• ios_health.biotin
• ios_health.pantothenic_acid
• ios_health.phosphorous
• ios_health.iodine
• ios_health.magnesium
• ios_health.zinc
• ios_health.selenium
• ios_health.copper
• ios_health.manganese
• ios_health.chromium
• ios_health.molybdenum
• ios_health.chloride
• ios_health.potassium
• ios_health.number_of_times_fallen
• ios_health.electrodermal_activity
• ios_health.inhaler_usage
• ios_health.respiratory_rate
• ios_health.body_temperature
• ios_health.sleep_analysis
• ios_health.forced_vital_capacity
• ios_health.forced_expiration_volume_1
• ios_health.peak_expiratory_flow_rate
• ios_health.caffeine
• ios_health.workout
• ios_health.blood_pressure_correlation
• ios_health.cycling_distance
• ios_health.water
• ios_health.uv_index
• ios_health.basal_body_temperature
• ios_health.cervical_mucus_quality
• ios_health.ovulation_test_results
• ios_health.menstruation
• ios_health.spotting
• ios_health.sexual_activity

Dados de amostra

{
  "id": "a1b2c3d41",
  "data_type": "ios_health.walking_running_distance",
  "type": "quantity",
  "value": 6.08,
  "was_user_entered": false,
  "start_date": "2016-07-04T18:11:54.000000Z",
  "end_date": "2016-07-04T18:12:09.000000Z"
}, {
  "id": "a1b2c3d42",
  "data_type": "ios_health.steps",
  "type": "quantity",
  "value": 8.0,
  "was_user_entered": false,
  "start_date": "2016-07-04T18:11:54.000000Z",
  "end_date": "2016-07-04T18:12:09.000000Z"
}, {
  "id": "a1b2c3d43",
  "data_type": "ios_health.caffeine",
  "type": "quantity",
  "value": 800.0,
  "unit": "mg",
  "was_user_entered": true,
  "start_date": "2016-07-04T18:11:54.000000Z",
  "end_date": "2016-07-04T18:12:09.000000Z"
}

iOS Safari

História

Atributos de dados

Estende o tipo de dados da visit .

Dados de amostra

{
  "data_type": "visit",
  "url": "https://reincubate.com/",
  "title": "Reincubate: the app data company",
  "date_created": "2020-01-01T00:00:00.000000Z"
}

Biscoitos

Atributos de dados

Estende o tipo de dados do cookie .

Dados de amostra

{
  "data_type": "cookie",
  "name": "sample_cookies",
  "value": "sample_value",
  "domain": "reincubate.com",
  "path": "/",
  "flags": "",
  "creation_date": "2020-01-01T00:00:00.000000Z",
  "expiry_date": "2020-01-01T00:00:00.000000Z"
}

Whatsapp

Mensagens

Atributos

Estende o tipo de dados da message .

Chamadas

Atributos

Estende o tipo de dados da call .

Viber

Chamadas

Mensagens

Atributos

Estende o tipo de dados da message .

Chamadas

Atributos

Estende o tipo de dados da call .

Conversas

Atributos

Estende o tipo de dados da conversation .

Contatos

Atributos

Estende o tipo de dados do contact .

Kik

Mensagens

Atributos

Estende o tipo de dados da message .

Contatos

Atributos

Estende o tipo de dados do contact .

Caminhada

Mensagens

Atributos

Estende o tipo de dados da message .

Postagens

Atributos

Estende o tipo de dados da message .

WeChat

Mensagens

Atributos

Estende o tipo de dados da message .

Tinder

Mensagens

Atributos

Estende o tipo de dados da message .

Linha

Mensagens

Atributos

Estende o tipo de dados da message .

Facebook Messenger

Mensagens

Atributos

Estende o tipo de dados da message .

Snapchat

Mensagens

Atributos

Estende o tipo de dados da message .

Histórias

Atributos

Estende o tipo de dados da message .

Skype

Mensagens

Atributos

Estende o tipo de dados da message .