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.
rirelay.instance.info attributen
| naam | type | Omschrijving |
|---|---|---|
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 van rirelay.source.info | Lijst met bronnen die aan de instantie zijn gekoppeld. |
date_created | datum Tijd | Datetime toen deze instantie voor het eerst werd gezien. |
date_last_seen | datum Tijd | Datetime wanneer deze instantie voor het laatst werd gezien. |
rirelay.source.info attributen
| naam | type | Omschrijving |
|---|---|---|
id | bron-ID | ID van het bronobject dat overeenkomt met deze relaisbron. |
uid | str | De unieke iOS-apparaat-ID van de Relay-bron. |
info | genest rirelay.source.info.info | Metadata voor deze Relay-bron. |
date_created | datum Tijd | Datetime toen deze bron voor het eerst werd gezien. |
date_last_seen | datum Tijd | Datetime wanneer deze bron voor het laatst werd gezien. |
rirelay.source.info.info attributen
| naam | type | Omschrijving |
|---|---|---|
name | str | Naam van de relaisbron. |
ios_version | str | IOS-versie die op de Relay-bron draait, namelijk 13.4 . |
apple_model_id | str | Model-ID van de Relay-bron, dwz iPhone7,2 . |
apple_serial | str | Serienummer van de F4KPWDR7G5DN , dwz F4KPWDR7G5DN . |
phone_number | optioneel, str | Telefoonnummer van de Relay-bron. |
is_encrypted | bool | Of de Relay-bron is ingesteld om gecodeerde back-ups te maken. |
Datatypen
Reïncubeer de gegevenstypen van de Relay-app
| identifier | Omschrijving |
|---|---|
ios_messages.messages | Haalt gegevens van iOS-berichten op, waaronder iMessage en sms. |
ios_contacts.contacts | Haalt gegevens van iOS-contacten op. |
ios_phone.calls | Haalt iOS-telefoongegevens op. |
ios_calendar.events | Haalt iOS-kalendergegevens op. |
ios_notes.notes | Haalt iOS Notes-gegevens op. |
ios_health.data | Haalt iOS Health-gegevens op. |
ios_safari.history | Haalt de browsergeschiedenis van Safari 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 de gespreksgeschiedenis van Viber 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 wandelberichten op. |
hike.posts | Haalt wandelposten 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
| identifier | Omschrijving |
|---|---|
.photos | Scant de back-up op afbeeldingsbestanden. |
.videos | Scant de back-up voor videobestanden. |
.recordings | Scant de back-up voor het opnemen van bestanden. |
.voicemails | Scant de back-up op voicemailbestanden. |
.app_usage | Scant de back-up voor 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 voor 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 |
Gegevenskenmerken
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 |
Gegevenskenmerken
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 | Omschrijving |
|---|---|---|
info_type | string, altijd ios_health.profile | Gegevenstype item-ID. |
gender | optionele string | Een van: Female , Male , Other . |
date_of_birth | optionele datum | Geboortedatum van de profieleigenaar. |
weight | optionele vlotter | Gewichtsmeting van de profieleigenaar, in kilogram. |
height | optionele vlotter | De 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 | Omschrijving |
|---|---|---|
id | draad | Item ID. |
data_type | draad | Gegevenstype item-ID. Een van de gegevenstypen van iOS Health. |
type | draad | Voorbeeldtype. Een van: quantity , binary , category . |
value | een van string, float, integer | Voorbeeldwaarde. Het type van dit veld is afhankelijk van het monster type attribuut. |
unit | optionele string | Instellen als een niet-standaard monstereenheid. |
was_user_entered | boolean | Of de gebruiker deze meting handmatig heeft ingevoerd. |
start_date | datum Tijd | Wanneer de bemonsteringsperiode is begonnen. |
end_date | datum Tijd | Wanneer de bemonsteringsperiode eindigde. |
Gegevenstypen voor iOS Health:
ios_health.body_mass_indexios_health.body_fat_percentageios_health.heightios_health.weightios_health.lean_body_massios_health.heart_rateios_health.stepsios_health.walking_running_distanceios_health.resting_energyios_health.active_energyios_health.flights_climbedios_health.oxygen_saturationios_health.blood_glucoseios_health.systolic_blood_pressureios_health.diastolic_blood_pressureios_health.blood_alcohol_contentios_health.peripheral_perfusion_indexios_health.total_fatios_health.polyunsaturated_fatios_health.monounsaturated_fatios_health.saturated_fatios_health.dietary_cholesterolios_health.sodiumios_health.carbohydratesios_health.fibreios_health.dietary_sugarios_health.dietary_energyios_health.proteinios_health.vitamin_aios_health.vitamin_b6ios_health.vitamin_b12ios_health.vitamin_cios_health.vitamin_dios_health.vitamin_eios_health.vitamin_kios_health.calciumios_health.ironios_health.thiamineios_health.riboflavinios_health.niacinios_health.folateios_health.biotinios_health.pantothenic_acidios_health.phosphorousios_health.iodineios_health.magnesiumios_health.zincios_health.seleniumios_health.copperios_health.manganeseios_health.chromiumios_health.molybdenumios_health.chlorideios_health.potassiumios_health.number_of_times_fallenios_health.electrodermal_activityios_health.inhaler_usageios_health.respiratory_rateios_health.body_temperatureios_health.sleep_analysisios_health.forced_vital_capacityios_health.forced_expiration_volume_1ios_health.peak_expiratory_flow_rateios_health.caffeineios_health.workoutios_health.blood_pressure_correlationios_health.cycling_distanceios_health.waterios_health.uv_indexios_health.basal_body_temperatureios_health.cervical_mucus_qualityios_health.ovulation_test_resultsios_health.menstruationios_health.spottingios_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.
| -berichten) | Haalt Viber-berichten op. | ||
|---|---|---|---|
viber.conversations | Haalt Viber-gesprekken op. | ||
[ viber.contacts ] (# viber-contact | |||
| ### Viber |
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.
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.