Vertex Messaging API

The Vertex Messaging API is available only to Vertex e-Invoicing customers. Using the API, you send, receive, track, and confirm messages and retrieve related documents. Vertex authenticates your application, and ecosio processes and routes messages through the relevant e-invoicing network.

If your application connects directly to ecosio using ecosio credentials, use the ecosio Messaging API instead. The APIs use different credentials, endpoints, and retrieval methods and aren’t interchangeable.

Authentication

You can authenticate to the Vertex Messaging API using an OAuth 2.0 access token, which you obtain in Vertex e-Invoicing.

Base URL

Test and production environments use separate credentials and have different base URLs. Both use the format https:{service_uri}/api/v1, where {service_uri} is the URL of the relevant environment, such as test or production. The following table provides an example base URL for each environment.

EnvironmentExample base URL
Productionhttps://e-invoicing-message.vertexcloud.com/api/v1
Testhttps://e-invoicing-message-test.vertexcloud.com/api/v1