Integración
Esta guía te guiará a través de la integración con el servicio de eventos para comenzar a recibir eventos. El servicio de eventos actualmente solo admite Apache Kafka como el intermediario de mensajes de backend.
Asume familiaridad con Kafka y no cubrirá cómo configurar un clúster de Kafka.
Requisitos
Anchor Platform enviará eventos al tema Kafka TRANSACTION
. El servicio de eventos consumirá eventos de este tema y los enviará a los puntos finales apropiados.
Configuración
Primero, el productor Kafka del servicio de eventos necesita ser configurado utilizando la sección event.queue
del archivo de configuración o configurando las variables de entorno. El siguiente es el conjunto de variables de entorno requeridas para configurar el productor Kafka del servicio de eventos:
- bash
- YAML
# dev.env
EVENTS_ENABLED=true
EVENTS_QUEUE_TYPE=kafka
EVENTS_QUEUE_KAFKA_BOOTSTRAP_SERVER=localhost:9092
# dev.services.yaml
events:
enabled: true
queue:
type: kafka
kafka:
bootstrap_server: localhost:9092
Anchor Platform permite configurar un subconjunto de la configuración del cliente del productor Kafka. Consulta el [archivo de valores predeterminados][default-values-file] para obtener más información sobre lo que está disponible. Para obtener más información sobre la configuración del cliente del productor Kafka, consulta la documentación de Kafka.
A continuación, el procesador de eventos necesita ser configurado en la sección event_processor
del archivo de configuración de Anchor Platform o configurando las variables de entorno.
- bash
- YAML
# dev.env
EVENT_PROCESSOR_CLIENT_STATUS_CALLBACK_ENABLED=true
EVENT_PROCESSOR_CALLBACK_API_REQUEST_ENABLED=true
# dev.services.yaml
event_processor:
client_status_callback:
enabled: true
callback_api_request:
enabled: true
Esto permitirá que el procesador de eventos comience a procesar eventos del tema TRANSACTION
. En este ejemplo, el procesador de eventos enviará eventos a los puntos finales de callback del cliente y del servidor empresarial.
Recibiendo Eventos
El servicio de eventos puede ser utilizado para enviar eventos a los puntos finales de callback del cliente y del servidor empresarial. El servicio de eventos enviará eventos a estos puntos finales como solicitudes HTTP POST con los datos del evento en el cuerpo de la solicitud.
Como Aplicación Cliente
Las aplicaciones cliente pueden recibir actualizaciones sobre las transacciones de sus usuarios y la información del cliente. El esquema de los datos del evento dependerá del tipo de evento que se envíe.
Para recibir eventos como una aplicación cliente, necesitarás exponer URLs de callback a las que el servicio de eventos pueda enviar eventos. El servicio de eventos enviará una solicitud POST a este punto final con los datos del evento en el cuerpo de la solicitud. El esquema de los datos del evento dependerá del tipo de evento que se envíe. Anchor Platform permite configurar puntos finales únicos por tipo de evento.
Anchor Platform solo enviará eventos a los clientes listados en la configuración del cliente. Consulta la [documentación de configuración del cliente][clients-config] para obtener más información.
Firma de Callback
Anchor Platform firma las solicitudes de callback que envía a las aplicaciones cliente. La firma se incluye en el encabezado Signature
de la solicitud. La especificación de la firma de URL de callback se puede encontrar en las especificaciones de protocolo SEP correspondientes.
Como Servidor Empresarial
Además de las actualizaciones del estado de las transacciones SEP, los servidores empresariales pueden recibir eventos sobre la creación de cotizaciones SEP-31 o actualizaciones de información del cliente SEP-12. El esquema de los datos del evento dependerá del tipo de evento que se envíe. Visita la documentación de la API de eventos para obtener más información sobre el esquema de los datos del evento.
Para recibir eventos como un servidor empresarial, necesitarás exponer una URL de callback a la que el servicio de eventos pueda enviar eventos. El servicio de eventos enviará una solicitud POST a este punto final con los datos del evento en el cuerpo de la solicitud.
Configuración
La API de callback del servicio de eventos puede ser configurada utilizando la sección callback_api
del archivo de configuración de Anchor Platform o configurando las variables de entorno.
El --event-processor
ignorará cualquier segmento de ruta especificado en callback_api.base_url
y en su lugar enviará eventos a [scheme]://[host]:[port]/event
. Este es un error, pero para no interrumpir a quienes usan el procesador de eventos, pospondremos la corrección de incluir segmentos de ruta en la versión 3 de Anchor Platform.
El siguiente es un ejemplo de cómo configurar la API de callback del servicio de eventos con autenticación JWT:
- bash
- YAML
# dev.env
# note `/callback` will not be used for event callbacks
# instead events will be sent to `http://localhost:8081/event`
# all other callbacks (rates, customer, etc.) will use the provided `/callback` root path
CALLBACK_API_BASE_URL=http://localhost:8081/callback
CALLBACK_API_AUTH_TYPE=jwt
CALLBACK_API_AUTH_JWT_EXPIRATION_MILLISECONDS=30000
CALLBACK_API_AUTH_JWT_HTTP_HEADER=Authorization
SECRET_CALLBACK_API_AUTH_SECRET="a secret for signing jwts"
# dev.services.yaml
callback_api:
base_url: http://localhost:8081/callback
auth:
type: jwt
jwt:
expiration_milliseconds: 30000
http_header: Authorization
El siguiente es un ejemplo de cómo configurar la API de callback del servicio de eventos con autenticación de clave API:
- bash
- YAML
# dev.env
CALLBACK_API_BASE_URL=http://localhost:8081/callback
CALLBACK_API_AUTH_TYPE=api_key
CALLBACK_API_AUTH_API_KEY_HTTP_HEADER=X-Api-Key
SECRET_CALLBACK_API_AUTH_SECRET="your API key"
# dev.services.yaml
callback_api:
base_url: http://localhost:8081/callback
auth:
type: api_key
api_key:
http_header: X-Api-Key
Esto configura la API de callback del servicio de eventos que será utilizada para enviar eventos a los puntos finales de callback del cliente y del servidor empresarial. Las siguientes son las opciones de configuración admitidas:
base_url
: La URL base del punto final de callback del servidor empresarial.secret
: El secreto que se utilizará al enviar eventos al punto final de callback del servidor empresarial. Esto se utiliza para firmar el cuerpo de la solicitud cuando se habilita la autenticación JWT y es la clave API cuando se habilita la autenticación de clave API.auth
: El método de autenticación que se utilizará al enviar eventos al punto final de callback del servidor empresarial. Las siguientes son los métodos de autenticación admitidos:JWT
: El servicio de eventos enviará un token web JSON (JWT) en el encabezadoAuthorization
de la solicitud. Las siguientes son las opciones de configuración admitidas:expiration_milliseconds
: El tiempo de caducidad del JWT en milisegundos.http_header
: El encabezado en el que se enviará el JWT.
API_KEY
: El servicio de eventos enviará una clave API en el encabezadoAuthorization
de la solicitud. Las siguientes son las opciones de configuración admitidas:http_header
: El encabezado en el que se enviará la clave API.