APIs

Generando una clave api de acceso 

Todos los puntos finales están protegidos por una clave API.

Una vez que genere la clave de API, envíela a través del encabezado de Autorización de la siguiente manera:

    Authorization: <apikey>

Para generar la clave de API, vaya a la página Credenciales, haga clic en ‘Generar clave de API’:

 

Con esta clave de API, tendrá acceso a todas las solicitudes posibles. El QR generado se utiliza para sincronizar la aplicación móvil con el tablero.

Bibliotecas de API 

Las bibliotecas oficiales están disponibles para ayudar a la integración con la API de Ironchip. Estas bibliotecas sirven como contenedores de API y manejan funciones como:

  • Autenticación de API transparente
  • Solicitudes para todos los puntos finales disponibles
  • Manejo de errores HTTP

Comprender las evaluaciones de riesgos 

Comprender las evaluaciones de riesgos 

Ironchip puede proporcionar cuatro tipos de evaluaciones de riesgo, que dependen de nuestro nivel de confianza en una determinada acción realizada por un dispositivo:

  • fraud: Ironchip considera que la acción realizada por el dispositivo es fraudulenta, involucrada en un fraude
  • high_risk: Ironchip considera que la acción (por ejemplo, registrarse, iniciar sesión) realizada por el dispositivo es potencialmente fraudulenta y le recomienda tomar medidas preventivas en estos escenarios.
  • low_risk: Ironchip considera que esta acción realizada por el dispositivo es segura de aceptar.
  • unknown_risk: Ironchip no puede proporcionar una evaluación precisa en el momento de la solicitud.

Evidencias de evaluación de riesgos 

Las API de Ironchip se basan en evidencia para proporcionar evaluaciones de riesgo. Esta decisión se basa en diferentes análisis a través de lentes distintos.

La siguiente tabla describe los posibles valores de evidencia, su significado y los casos de uso a los que afectan.

Comprender el tipo de coincidencia del sensor 

Tipo de coincidencia Descripción
gps Cuando Ironchip es capaz de realizar comparaciones por datos GPS.
wifi_scan Cuando Ironchip puede realizar comparaciones mediante sensores Wi-Fi, pero no se encuentran redes conectadas coincidentes.
wifi_connection Cuando Ironchip es capaz de realizar comparaciones por redes Wi-Fi conectadas.
mobile_networks Cuando Ironchip es capaz de realizar comparaciones por redes móviles conectadas.

Decisión de evaluación de riesgos 

Las API de Ironchip se basan en decisiones para proporcionar evaluaciones de riesgo. Esta decisión se basa en diferentes análisis a través de lentes distintos.

La siguiente tabla describe los posibles valores de decisión, su significado y los casos de uso que afectan.

Decisión Descripción Tipo
SIM Swapping / ATO Adquisición de cuenta detectada basada o no en el ataque Sim Swapping (dependiendo de la protección del usuario del cliente) string
Phising Ataque de phishing detectado desde una ubicación específica (ATO múltiple) string
Synthetic identity Ataque de identidad sintética detectado string
New user Nuevo usuario detectado en la plataforma de Ironchip string
Location fraud Intento de fraude de ubicación detectado por parte del usuario comparando todas las fuentes de datos de ubicación string
Banned location Ubicación detectada desde un lugar prohibido. En el ejemplo: Ubicación detectada desde Rusia string
Device Swapping Intercambio de dispositivo legítimo detectado de un usuario string
Location Swapping Se detectó un intercambio de ubicación legítimo de un usuario string
Common usage Uso común detectado string

API de Reportes 

API de Reportes de Fraude Basado en la Ubicación

Información 

Versión 

api/v1.0.5-5-gc944fcf

Contacto 

Página de soporte info@ironchip.com https://www.ironchip.com/es/products/frauddetection/

Términos de Servicio 

https://www.ironchip.com/en/term_uses/termOfUses/

Negociación de Contenido 

Esquemas de URI 

  • http

Utiliza 

  • application/json

Tipo de respuesta 

  • application/json

Control de acceso 

Esquemas de Seguridad 

ApiKeyAuth (encabezado: Autorización)

Todos los Puntos de Conexión 

Informe 

Método URI Nombre Resumen
GET /reports Obtener reportes Este punto de conexión permite al cliente obtener los reportes de la aplicación. Se debe permitir al usuario consultar reportes de la aplicación referenciada.
GET /reports/{transaction_id} Obtener reportes mediante ID de transacción Este punto de conexión permite al cliente obtener los reportes de la aplicación proporcionando el ID de la transacción. Se debe permitir al usuario consultar reportes de la aplicación referenciada.

Feedback 

Método URI Nombre Resumen
POST /feedback/{transaction_id} Publicar feedback con ID de transacción Este punto de conexión permite al cliente enviar feedback sobre el informe recibido para mejorar las futuras detecciones de fraude.

Reportes 

Este punto de conexión permite al cliente obtener los reportes de la aplicación. Se debe permitir al usuario consultar reportes de la Aplicación. (ObtenerReportes

GET /reports

Obtén todos los reportes de la aplicación. Por defecto, se paginarán a 20 reportes por página.

Tipo de respuesta 

  • application/json

Requisitos de Seguridad 

  • ApiKeyAuth

Parámetros 

Nombre Origen Tipo Tipo en Go Separador Obligatorio Obligatorio Descripción
limit query entero int64     20 Límite del número de reportes
page query entero int64     1 Página de reportes

Ejemplo 

curl -X 'GET' \
'https://report.lbfraud.ironchip.com/reports?limit=20&page=1' \
-H 'accept: application/json' \
-H 'Authorization: example-api-key'

Todas las respuestas 

Código Estado Descripción Tiene cabeceras Esquema
200 OK OK   esquema
404 No Encontrado No Encontrado   esquema
500 Error Interno del Servido Error Interno del Servido   esquema

Respuestas 

200 - OK 

Estado: OK

Esquema 

[ ]ModelsReport

404 - No Encontrado 

Estado: No Encontrado

Esquema 

ModelsRestError

500 - Error Interno del Servidor 

Estado: Error Interno del Servidor

Esquema 

ModelsRestError

Este punto de conexión permite al cliente obtener los reportes de la aplicación proporcionando el ID de la transacción. Se debe permitir al usuario consultar reportes de la Aplicación. (GetReportsTransactionID

GET /reports/{transaction_id}

Obtén los reportes de la aplicación filtrados por ID de transacción. Los reportes se paginarán por defecto a 20 por página. El parámetro de tiempo de espera es el tiempo máximo de espera para que se procese el informe; se debe utilizar si se solicita el informe antes de que se complete la transacción.

Tipo de respuesta 

  • application/json

Requisitos de Seguridad 

  • ApiKeyAuth

Parámetros 

Nombre Origen Tipo Tipo en Go Obligatorio Predeterminado Descripción
transaction_id path string string   ID de transacción
limit query entero int64   20 Límite del número de reportes
page query entero int64   1 Desde la generación del informe (números y sufijo de unidad)
since query string string   "30d" Desde la generación del informe (números y sufijo de unidad)
timeout query string string   "5s" Tiempo de espera en segundos

Ejemplo 

curl -X 'GET' \
'https://report.lbfraud.ironchip.com/reports/example-transaction-id?limit=1&page=1&since=30d&timeout=5s' \
-H 'accept: application/json' \
-H 'Authorization: example-api-key'

Todas las respuestas 

Código Estado Descripción Tiene cabeceras Esquema
200 OK OK   esquema
404 No Encontrado No Encontrado   esquema
500 Error Interno del Servidor Error Interno del Servidor   esquema

Respuestas 

200 - OK 

Estado: OK

Esquema 

[ ]ModelsReport

404 - No Encontrado 

Estado: No Encontrado

Esquema 

ModelsRestError

500 - Error Interno del Servidor 

Estado: Error Interno del Servidor

Esquema 

ModelsRestError

Feedback 

Esta ruta permite al cliente publicar comentarios sobre el informe recibido para mejorar las futuras detecciones de fraude. (PostFeedbackTransactionID

POST /feedback/{transaction_id}

Comentar sobre la transacción recibida para mejorar los resultados futuros en detecciones de fraude.

Utiliza 

  • application/json

Requisitos de Seguridad 

  • ApiKeyAuth

Parámetros 

Nombre Origen Tipo Tipo en Go Separador Obligatorio Predeterminado Descripción
transaction_id path string string     ID de Transacción
feedback body ModelsFeedback models.ModelsFeedback     Feedback

Ejemplo 

curl -X 'POST' \
'https://report.lbfraud.ironchip.com/feedback/example-transaction-id' \
-H 'accept: application/json' \
-H 'Authorization: example-api-key' \
-H 'Content-Type: application/json' \
-d '{
"behaviour": {
"desired": {
"fraud_cases": [
"device swapping",
"location swapping"
],
"risk_assignment": "clear"
}
},
"impact": {
"description": "The transaction has been detected as fraud rather than low"
},
"reporter": {
"email": "TatianaPrieto@ironchip.com",
"name": "Tatiana",
"surname": "Prieto"
},
"situation": {
"description": "The customer has downloaded the APP to an unknown device located in a new country"
},
"valuation": {
"annotations": "It is not possible to difference between real and fake client without client confirmation",
"score": 8,
"type": "Corrective"
}
}'

Todas las Respuestas 

Código Estado Descripción Tiene encabezados Esquema
200 OK OK   esquema
404 No Encontrado No Encontrado   esquema
500 Error Interno del Servidor Error Interno del Servidor   esquema

Respuestas 

200 - OK 

Estado: OK

Esquema 

404 - No Encontrado 

Estado: No Encontrado

Esquema 

ModelsRestError

500 - Error Interno del Servidor 

Estado: Error Interno del Servidor

Esquema 

ModelsRestError

Modelos 

models.Address 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción
city string string     Ciudad donde ocurrió el informe
country string string     Nombre del país
country_code string string     Los códigos de país son cortos alfabéticos (ISO 3166)
latitude numero float64     Coordenada que especifica la posición norte-sur de un punto en la superficie de la Tierra
longitude numero float64     Coordenada que especifica la posición este-oeste de un punto en la superficie de la Tierra
region string string     Región geográfica de un país utilizada con fines administrativos
state string string     Áreas geográficas en las que se divide un país en particular

models.Behaviour 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción
desired ModelsDesiredBehaviour ModelsDesiredBehaviour   Comportamiento deseado

models.DesiredBehaviour 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción Ejemplo
fraud_cases []string []string   Caso de informe, razón ["cambio dispositivo","cambio ubicación"]
risk_assignment string string Nivel de riesgo (fraude, alto, bajo, claro)  

models.Device 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción
id string string     ID único del dispositivo
integrity ModelsIntegrity ModelsIntegrity     Integridad del dispositivo
model string string     Modelo del dispositivo
sensors ModelsSensors ModelsSensors     Sensores del dispositivo activados

models.EmLocation 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
address ModelsAddress ModelsAddress     Dirección de ubicación  
id string string     ID de ubicación  

models.Event 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
fraud_cases []string []string     Caso de informe, razón  
id string string     ID de transacción de la aplicación  
risk_assignment string string     Nivel de riesgo (fraude, alto, bajo, claro)  
timestamp entero int64     Marca temporal del evento  

models.Feedback 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción
behaviour ModelsBehaviour ModelsBehaviour Comportamiento del producto: esperado
impact ModelsImpact ModelsImpact   Impacto que tiene los resultados
reporter ModelsReporter ModelsReporter   Datos identificativos de la persona que envía el feedback
situation ModelsSituation ModelsSituation   La situación cuando se realizó el proceso
valuation ModelsValuation ModelosValoracion   Valoración de los resultados

models.GeoLocation 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
address ModelsAddress ModelsAddress     Dirección de ubicación  
id string string     ID de ubicación  

models.IP 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
address ModelsAddress ModelsAddress     Dirección de ubicación  
tor boolean bool     Está utilizando TOR  
vpn boolean bool     Está utilizando VPN  

models.Impact 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción Ejemplo
description string string   Descripción del impacto generado La transacción se ha detectado como fraude en lugar de baja

models.Integrity 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
debugged booleano bool     El dispositivo está abierto en modo de depuración o la aplicación no está construida  
emulated booleano bool     El dispositivo está siendo emulado  
gps_spoofed booleano bool     ¿Se está falsificando la ubicación o señal del GPS?  
rooted booleano bool     ¿El dispositivo está rooteado o tiene Jailbreak?  

models.Location 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción
address ModelsAddress ModelsAddress   Dirección de ubicación
id string string   ID de ubicación
location_type string string   Tipo de ubicación (ip, geo, wifi, lte, cdma, wcdma, gsm)

models.Report 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción
application_id string string   ID de aplicación
descriptive_report string string   Resumen descriptivo sobre los datos del reporte
device ModelsDevice ModelsDevice   Información del dispositivo
em_location ModelsEmLocation ModelsEmLocation   Información de ubicación EM
event ModelsEvent ModelsEvent   Resultado del evento del informe
extra_data interface{} interface{}   Datos adicionales proporcionados en la transacción (JSON)
geo_location ModelsGeoLocation ModelsGeoLocation   Información de ubicación GEO
id integer int64   ID generado del informe
ip ModelsIP ModelsIP   Información de IP
location ModelsLocation ModelsLocation   Información de ubicación
timestamp integer int64   Marca de tiempo de generación del informe en nanosegundos
transaction_id string string   ID de transacción
user ModelsUser ModelsUser   Información del usuario

models.Reporter 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción Ejemplo
email string string   Correo electrónico identificador TatianaPrieto@ironchip.com
name string string   Nombre identificador Tatiana
surname string string   Apellido identificador Prieto

models.RestError 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
cause string string        
error string string        
error_code string string        
traceability_id string string        

models.Sensors 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
gps boolean bool     ¿Está activado el sensor GPS?  
mobile_networks boolean bool     ¿El dispositivo puede obtener redes móviles?  
wifi boolean bool     ¿Tiene el dispositivo activado el sensor WiFi?  
wifi_connected boolean bool     ¿El dispositivo está conectado a alguna red WiFi?  

models.Situation 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción Ejemplo
description string string   Descripción de la situación cuando se realizó el proceso El cliente ha descargado la aplicación en un dispositivo desconocido ubicado en un nuevo país

models.User 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
id string string     ID de usuario iddeusuarioejemplo

models.Valuation 

Propiedades

Nombre Tipo Tipo en Go Requerido Descripción Ejemplo
annotations string string   Anotaciones No es posible diferenciar entre un cliente real y falso sin la confirmación del cliente
score integer int64   Puntuación de valoración (0-10) 8
type string string   Tipo de valoración de feedback (Positiva, Negativa, Correctiva) Correctiva

models.Version 

Propiedades

Nombre Tipo Tipo en Go Requerido Predeterminado Descripción Ejemplo
build_date string string        
commit string string        
version string string       1.0.0