Important

You are browsing the documentation for version 4.2 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Security Support ends in January 2024. Read version 5.0 (the latest LTS version) of the Oro documentation to get the updated information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Authentication

All connections to socket server are protected with Sync authentication tickets.

Before connecting, the client should receive the connection ticket and pass it as part of the connection URL as a ticket query parameter.

For the frontend clients, the authentication ticket can be received by calling the POST request to oro_sync_ticket route. A response of this request is a JSON object with the ticket field that contains a one-time authentication ticket.

For backend clients, the authentication ticket can be received by calling the generateTicket method of the oro_sync.authentication.ticket_provider service.

All tickets have the default limited lifetime of 300 seconds.

When authentication is successful, the client is able to subscribe and send new messages to topics.