I need help with a REST API query, POST "/fax/send". Can you help me with the authentication, body a

Vindhya Ranpise

I need help with a REST API query, POST "/fax/send".

Can you help me with the authentication, body and headers for this API.

Also, as this API is Open API, how to use it? what will be localhost, I should be using for my machine.

LaurenceLabonté

The authentication is describe at : https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-onpremises-soap-web-services/2

The body and header are describe here https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-onpremises-soap-web-services/3 and include a curl example.

The endpoint url should be https://{{api_endpoint}}:8443/faxservice/Fax where the api_endpoint is the ip where the XM Fax server is located on your network.

If you are not familiar with Open API, you can access more sample made with Postman here: https://github.com/opentext/XM-Fax/tree/main/Postman

LaurenceLabonté

XM Fax Cloud and On-Premises are two different things. The link I've shared are for On-Premises installation only. If your XM Fax is host by us on the cloud (portal.xmedius.com/ca/eu), then the tutorial for Cloud needs to be looked at. The authentication is very different for both type of installation

The REST Api is not yet available for Cloud customers. It's schedule for the 24.4 release, in the upcoming months. Currently, only SOAP Apis are available for Cloud.

For Cloud authentication, see https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-soap-web-services/3 . If a user token is chosen, the only requirement is that's it's for a existing valid user from the XM Fax portal.

LaurenceLabonté

The authentication is describe at : https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-onpremises-soap-web-services/2

The body and header are describe here https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-onpremises-soap-web-services/3 and include a curl example.

The endpoint url should be https://{{api_endpoint}}:8443/faxservice/Fax where the api_endpoint is the ip where the XM Fax server is located on your network.

If you are not familiar with Open API, you can access more sample made with Postman here: https://github.com/opentext/XM-Fax/tree/main/Postman

Vindhya Ranpise

One follow up doubt, if the XM fax is hosted on cloud, then what should be the API endpoint.
Also, in the authentication, can't we have any service account rather than using personal account for authentication?

LaurenceLabonté

XM Fax Cloud and On-Premises are two different things. The link I've shared are for On-Premises installation only. If your XM Fax is host by us on the cloud (portal.xmedius.com/ca/eu), then the tutorial for Cloud needs to be looked at. The authentication is very different for both type of installation

The REST Api is not yet available for Cloud customers. It's schedule for the 24.4 release, in the upcoming months. Currently, only SOAP Apis are available for Cloud.

For Cloud authentication, see https://developer.opentext.com/ce/products/xm-fax/tutorials/get-started-with-xm-fax-soap-web-services/3 . If a user token is chosen, the only requirement is that's it's for a existing valid user from the XM Fax portal.