Relay-Service erneut inkubieren

Sitzungen

Ein Pairing-Prozess wird verwendet, um eine Verbindung zwischen einem Benutzer der API und einer App-Instanz von Reincubate Relay herzustellen. Standardmäßig zeigt das Reincubate Relay seinen Pairing-Code an, wenn es nicht gepaart ist. Der Benutzer muss dies Ihrer Anwendung mitteilen, damit diese über den folgenden Aufruf eine gültige Sitzung erstellt.

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

Sobald die Sitzung erstellt wird, werden Sie in der Lage sein , Informationen über die App - Instanz über die Sitzung des Objekts anzuzeigen source Attribut. Das sollte ungefähr so aussehen:

{
  "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"
  },
  ...
}

Abonnements

Im Gegensatz zu anderen Diensten ist ein Abonnement erforderlich, bevor die API mit dem Abrufen von Daten von einer Reincubate Relay-Quelle beginnen kann. Dies soll dem Benutzer der App helfen, genau zu verstehen, auf welche Daten zugegriffen wird.

Abonnements können nur für Quellen des Typs rirelay.source werden, bei denen es sich um untergeordnete Elemente der Reincubate Relay-Instanz handelt. Die Sitzung, die beim Abfragen der Quelle verwendet werden soll, muss ebenfalls angegeben werden.

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

Das Abonnement bleibt in einem ausstehenden Zustand, bis der Benutzer Zugriff auf das bestimmte Gerät in der Benutzeroberfläche der Reincubate Relay-App gewährt hat. Sobald dies erlaubt ist, wechselt der Status zu active .

Bei der Aktivierung des Abonnements wird sofort eine erste Umfrage erstellt. Nachfolgende Umfragen werden erstellt, wenn die Reincubate Relay-App die API über neue Daten benachrichtigt.

Umfragen

Umfragen können auch manuell für Quellen mit aktiven Abonnements erstellt werden. Dies ist hilfreich bei der Fehlerbehebung bei abgerufenen Daten oder beim Testen neuer Datentypen.

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

Veranstaltungen

Um über asynchrone Änderungen auf dem Laufenden zu bleiben, z. B. wenn ein Abonnement eine neue Umfrage erstellt oder eine Sitzung abläuft, muss Ihre Implementierung Ereignisbenachrichtigungen von der API über einen Webhook-Endpunkt empfangen.

Ausführliche Informationen zum Einrichten und Konfigurieren Ihres Webhook-Endpunkts finden Sie unter Konfigurieren von Webhooks .

Infotypen

Der Relay-Dienst unterstützt derzeit nur das Abrufen von Informationen aus rirelay.instance Quellen, einschließlich verschachtelter Informationen zu allen zugehörigen rirelay.source Quellen.

rirelay.instance.info Attribute

Attribute von rirelay.source.info

Attribute von rirelay.source.info.info

Beachten Sie, dass name , ios_version , apple_model_id , apple_serial und is_encrypted , sind auch in den enthaltenen verschachtelten info Daten auf Source und sind daher zugänglich direkt über API - Endpunkte.

Für andere Attribute wie phone_number ist eine vollständige Abfrage von rirelay.instance.info erforderlich – da es sich um personenbezogene Daten handelt, die nicht von der API gespeichert werden.

Datentypen

Relay-App-Datentypen neu inkubieren

Aggregierte Relay-Datentypen neu inkubieren

iOS-Nachrichten

Mitteilungen

Datenattribute

Erweitert den message .

Beispieldaten

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

iOS-Kontakte

Kontakte

Datenattribute

Erweitert den contact .

Beispieldaten

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

iOS-Telefon

Anrufe

Datenattribute

Erweitert den call

Beispieldaten

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

iOS-Kalender

Veranstaltungen

Datenattribute

Erweitert den event .

Beispieldaten

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

iOS-Hinweise

Anmerkungen

Datenattribute

Erweitert den note .

iOS Gesundheit

Daten, die mit der iOS Health-App und dem HealthKit-Framework verknüpft sind.

Daten

ios_health.profile Attribute

ios_health.profile Beispiel

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

ios_health.sample Attribute

iOS Health-Datentypen:

• 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

Beispieldaten

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

Geschichte

Datenattribute

Erweitert den visit Datentyp.

Beispieldaten

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

Kekse

Datenattribute

Erweitert den cookie Datentyp.

Beispieldaten

{
  "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 & WhatsApp for Business

WhatsApp Messages

Attribute

Erweitert den message .

WhatsApp Calls

Attribute

Erweitert den call

WhatsApp for Business Messages

Attribute

Erweitert den message .

Viber

Anrufe

Mitteilungen

Attribute

Erweitert den message .

Anrufe

Attribute

Erweitert den call

Gespräche

Attribute

Erweitert den conversation .

Kontakte

Attribute

Erweitert den contact .

Kik

Mitteilungen

Attribute

Erweitert den message .

Kontakte

Attribute

Erweitert den contact .

Wanderung

Mitteilungen

Attribute

Erweitert den message .

Beiträge

Attribute

Erweitert den message .

WeChat

Mitteilungen

Attribute

Erweitert den message .

Tinder

Mitteilungen

Attribute

Erweitert den message .

Linie

Mitteilungen

Attribute

Erweitert den message .

Facebook Messenger

Mitteilungen

Attribute

Erweitert den message .

Snapchat

Mitteilungen

Attribute

Erweitert den message .

Geschichten

Attribute

Erweitert den message .

Skype

Mitteilungen

Attribute

Erweitert den message .