Reïncubeer relayservice
Sessions
Een koppelingsproces wordt gebruikt om een koppeling tot stand te brengen tussen een gebruiker van de API en een exemplaar van de Reincubate Relay-app. Standaard, indien niet gekoppeld, geeft het Reincubate-relais de koppelingscode weer. De gebruiker moet dit aan uw toepassing geven om een geldige sessie te kunnen maken, via het volgende gesprek.
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>" } }'
Zodra de sessie is gemaakt, kunt u voor meer informatie over de app bijvoorbeeld via de sessie object source
attribuut. Dit zou er ongeveer zo uit moeten zien:
{ "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" }, ... }
abonnementen
In tegenstelling tot andere services is een abonnement vereist voordat de API kan beginnen met het ophalen van gegevens uit een Reincubate Relay-bron. Dit helpt de gebruiker van de app precies te begrijpen tot welke gegevens toegang wordt verkregen.
Abonnementen kunnen alleen worden gemaakt voor rirelay.source
type rirelay.source
, de onderliggende elementen van de Reincubate Relay-instantie. De sessie die moet worden gebruikt bij het pollen van de bron moet ook worden opgegeven.
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"] } }'
Het abonnement blijft in behandeling totdat de gebruiker toegang heeft verleend tot het specifieke apparaat in de Reincubate Relay-app-interface. Zodra het is toegestaan, wordt de status omgezet naar active
.
Een eerste peiling wordt onmiddellijk gemaakt bij het activeren van een abonnement, en vervolgens worden peilingen gemaakt wanneer de Reincubate Relay-app de API op de hoogte brengt van nieuwe gegevens.
Polls
Peilingen kunnen ook handmatig worden gemaakt tegen bronnen met actieve abonnementen. Dit is handig bij het oplossen van problemen met opgehaalde gegevens of bij het testen van nieuwe gegevenstypen.
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"] } }'
Evenementen
Om op de hoogte te blijven van asynchrone wijzigingen, zoals een abonnement voor het maken van een nieuwe peiling of een sessie die verloopt, moet uw implementatie gebeurtenismeldingen van de API ontvangen via een webhook-eindpunt.
Voor meer informatie over hoe te installeren en uw webhook eindpunt configureren, zie configureren webhooks .
Info soorten
De Relay-service ondersteunt momenteel alleen het ophalen van informatie uit rirelay.instance
bronnen, inclusief geneste informatie over alle bijbehorende rirelay.source
bronnen.
rirelay.instance.info
attributen
naam | type | Beschrijving |
---|---|---|
id | bron-ID | ID van het bronobject dat overeenkomt met deze Relay-instantie. |
version | str | Versie van de Reincubate Relay-app. |
os | str | Identificatie van het besturingssysteem waarop de Reincubate Relay-app draait. |
sources | lijst met rirelay.source.info | Lijst met bronnen die aan de instantie zijn gekoppeld. |
date_created | datum Tijd | Datum/tijd waarop deze instantie voor het eerst werd gezien. |
date_last_seen | datum Tijd | Datum/tijd waarop deze instantie voor het laatst is gezien. |
rirelay.source.info
attributen
naam | type | Beschrijving |
---|---|---|
id | bron-ID | ID van het bronobject dat overeenkomt met deze Relay-bron. |
uid | str | De unieke iOS-apparaat-ID van de Relay-bron. |
info | geneste rirelay.source.info.info | Metadata voor deze Relay-bron. |
date_created | datum Tijd | Datum en tijd waarop deze bron voor het eerst werd gezien. |
date_last_seen | datum Tijd | Datum en tijd waarop deze bron voor het laatst is gezien. |
rirelay.source.info.info
attributen
Merk op dat name
, ios_version
, apple_model_id
, apple_serial
en is_encrypted
, zijn ook opgenomen in de geneste info
gegevens over de Source
-objecten, en zijn daarom direct toegankelijk via API endpoints.
Voor andere attributen, zoals phone_number
, is een volledige poll voor rirelay.instance.info
vereist – aangezien dit persoonlijk identificeerbare informatie is die niet door de API wordt opgeslagen.
naam | type | Beschrijving |
---|---|---|
name | str | Naam van de relaisbron. Beschikbaar in Source.info . |
ios_version | str | Versie van iOS die draait op de Relay-bron, dwz 13.4 . Beschikbaar in Source.info . |
apple_model_id | str | Model-ID van de iPhone7,2 , dwz iPhone7,2 . Beschikbaar in Source.info . |
apple_serial | str | Serienummer van de F4KPWDR7G5DN , dwz F4KPWDR7G5DN . Beschikbaar in Source.info . |
phone_number | optioneel, streng | Telefoonnummer van de relaisbron. Is leeg als mobiele functionaliteit niet is ingeschakeld op het apparaat (dwz geen simkaart of alleen wifi). |
is_encrypted | bool | Of de Relay-bron is ingesteld om versleutelde back-ups te maken. Beschikbaar in Source.info . |
Datatypen
Reïncubeer de gegevenstypen van de Relay-app
identificatie | Beschrijving |
---|---|
ios_messages.messages | Haalt iOS-berichtengegevens op, inclusief iMessage en sms. |
ios_contacts.contacts | Haalt iOS-contactgegevens op. |
ios_phone.calls | Haalt iOS-telefoongegevens op. |
ios_calendar.events | Haalt iOS-agendagegevens op. |
ios_notes.notes | Haalt iOS Notes-gegevens op. |
ios_health.data | Haalt iOS-gezondheidsgegevens op. |
ios_safari.history | Haalt de geschiedenisgegevens van de Safari-browser op. |
ios_safari.cookies | Haalt Safari-cookiegegevens op. |
whatsapp.messages | Haalt WhatsApp-berichten op. |
whatsapp.calls | Haalt WhatsApp-oproepgeschiedenis op. |
viber.messages | Haalt Viber-berichten op. |
viber.calls | Haalt Viber-oproepgeschiedenis op. |
viber.conversations | Haalt Viber-gesprekken op. |
viber.contacts | Haalt Viber-contacten op. |
kik.messages | Haalt Kik-berichten op. |
kik.contacts | Haalt Kik-contacten op. |
hike.messages | Haalt Hike-berichten op. |
hike.posts | Haalt Hike-berichten op. |
wechat.messages | Haalt WeChat-berichten op. |
tinder.messages | Haalt Tinder-berichten op. |
line.messages | Haalt lijnberichten op. |
facebook.messages | Haalt Facebook-berichten op. |
snapchat.messages | Haalt Snapchat-berichten op. |
snapchat.stories | Haalt Snapchat-verhalen op. |
skype.messages | Haalt Skype-berichten op. |
Reincubate Relay geaggregeerde gegevenstypen
identificatie | Beschrijving |
---|---|
.photos | Scant de back-up op afbeeldingsbestanden. |
.videos | Scant de back-up op videobestanden. |
.recordings | Scant de back-up voor opnamebestanden. |
.voicemails | Scant de back-up op voicemailbestanden. |
.app_usage | Scant de back-up op informatie over app-gebruik. |
.installed_apps | Scant de back-up voor geïnstalleerde app-informatie. |
.locations | Scant de back-up voor locaties. |
.linked_watches | Scant de back-up op gekoppelde Apple Watch-informatie. |
iOS-berichten
Berichten
Gegevenstype-ID | ios_messages.messages |
Data attributen
Breidt het message
uit.
Voorbeeldgegevens
{ "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-contacten
Contacten
Gegevenstype-ID | ios_contacts.contacts |
Data attributen
Breidt het type contact
uit.
Voorbeeldgegevens
{ "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-telefoon
Oproepen
Gegevenstype-ID | ios_phone.calls |
Data attributen
Breidt het call
uit.
Voorbeeldgegevens
{ "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-agenda
Evenementen
Gegevenstype-ID | ios_calendar.events |
Data attributen
Breidt het gegevenstype van de event
uit.
Voorbeeldgegevens
{ "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-notities
Opmerkingen
Gegevenstype-ID | ios_notes.notes |
Data attributen
Breidt het gegevenstype van de note
uit.
iOS-gezondheid
Gegevens die zijn gekoppeld aan de iOS Health-app en het HealthKit-framework.
Gegevens
Gegevenstype-ID | ios_health.data |
ios_health.profile
kenmerken
naam | type | Beschrijving |
---|---|---|
info_type | string, altijd ios_health.profile | Artikelgegevenstype ID. |
gender | optionele string | Een van: Female , Male , Other . |
date_of_birth | optionele datum | De geboortedatum van de profieleigenaar. |
weight | optionele float | De gewichtsmeting van de profieleigenaar, in kilogram. |
height | optionele float | Hoogtemeting van de profieleigenaar, in meters. |
blood_type | optionele string | De bloedgroep van de profieleigenaar. |
fitzpatrick_skin_type | optionele string | Het Fitzpatrick-huidtype van de profieleigenaar. Een van: Type I , Type II , Type II , Type IV , Type V |
ios_health.profile
voorbeeld
{ "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
kenmerken
naam | type | Beschrijving |
---|---|---|
id | snaar | Item ID. |
data_type | snaar | Artikelgegevenstype ID. Een van de iOS Health-gegevenstypen. |
type | snaar | Soort monster. Een van: quantity , binary , category . |
value | een van string, float, integer | Voorbeeldwaarde. Het type van dit veld hangt af van het kenmerk type |
unit | optionele string | Instellen als een niet-standaard voorbeeldeenheid. |
was_user_entered | booleaans | Of de gebruiker deze meting handmatig heeft ingevoerd. |
start_date | datum Tijd | Wanneer de bemonsteringsperiode begon. |
end_date | datum Tijd | Wanneer de bemonsteringsperiode is afgelopen. |
Gegevenstypen voor iOS Health:
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
Voorbeeldgegevens
{ "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
Geschiedenis
Gegevenstype-ID | ios_safari.history |
Data attributen
Breidt het visit
uit.
Voorbeeldgegevens
{ "data_type": "visit", "url": "https://reincubate.com/", "title": "Reincubate: the app data company", "date_created": "2020-01-01T00:00:00.000000Z" }
Cookies
Gegevenstype-ID | ios_safari.cookies |
Data attributen
Breidt het cookie
uit.
Voorbeeldgegevens
{ "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" }
Berichten
Gegevenstype-ID | whatsapp.messages |
attributen
Breidt het message
uit.
Oproepen
Gegevenstype-ID | whatsapp.calls |
attributen
Breidt het call
uit.
Viber
oproepen
viber.messages | Haalt Viber-berichten op. |
viber.calls | Haalt Viber-oproepgeschiedenis op. |
viber.conversations | Haalt Viber-gesprekken op. |
viber.contacts | Haalt Viber-contacten op. |
Berichten
Gegevenstype-ID | viber.messages |
attributen
Breidt het message
uit.
oproepen
Gegevenstype-ID | viber.calls |
attributen
Breidt het call
uit.
Gesprekken
Gegevenstype-ID | viber.conversations |
attributen
Breidt het conversation
uit.
Contacten
Gegevenstype-ID | viber.contacts |
attributen
Breidt het type contact
uit.
Kik
Berichten
Gegevenstype-ID | kik.messages |
attributen
Breidt het message
uit.
Contacten
Gegevenstype-ID | kik.contacts |
attributen
Breidt het type contact
uit.
Wandeltocht
hike.messages | Haalt Hike-berichten op. |
hike.posts | Haalt Hike-berichten op. |
Berichten
Gegevenstype-ID | hike.messages |
attributen
Breidt het message
uit.
Berichten
Gegevenstype-ID | hike.posts |
attributen
Breidt het message
uit.
Berichten
Gegevenstype-ID | wechat.messages |
attributen
Breidt het message
uit.
Tondel
Berichten
Gegevenstype-ID | tinder.messages |
attributen
Breidt het message
uit.
Lijn
Berichten
Gegevenstype-ID | line.messages |
attributen
Breidt het message
uit.
Facebook messenger
Berichten
Gegevenstype-ID | facebook.messenger |
attributen
Breidt het message
uit.
Snapchat
Berichten
Gegevenstype-ID | snapchat.messages |
attributen
Breidt het message
uit.
Verhalen
Gegevenstype-ID | snapchat.stories |
attributen
Breidt het message
uit.
Skype
Berichten
Gegevenstype-ID | skype.messages |
attributen
Breidt het message
uit.