Release NotesUser InterfaceSystem Status
API Reference

End Point

This is where Encoding.com API requests are sent.

📘

To send API requests to Encoding.com, please send HTTPS POST requests to:

https://manage.encoding.com

📘

IP

52.200.5.10

All client requests and server responses use the XML or JSON format. There are two ways to send request body to the server:

  • As HTTP Request Body
    Content-Type should be application/xml for XML and application/json for JSON
    Request Body is an XML or JSON string
  • As URL-encoded string
    Content-Type should be content-type: application/x-www-form-urlencoded
    Request Body is URL-encoded string contains form data with a single parameter named xml or json for JSON request.
    Note that this could result in source and destination URLs being URL-encoded twice, which is the proper format of submissions to the API for reasons of backward compatibility.
POST https://manage.encoding.com/ HTTP/2
Host: manage.encoding.com
Content-Type: application/xml

<?xml version="1.0"?><query><action>[Action]</action><userid>[UserID]</userid><userkey>[UserKey]</userkey></query>

POST https://manage.encoding.com/ HTTP/2
Host: manage.encoding.com
Content-Type: application/json

{"query":{"action":"[Action]","userid":"[UserID]","userkey":"[UserKey]"}}

POST https://manage.encoding.com/ HTTP/2
Host: manage.encoding.com
Content-Type: application/x-www-form-urlencoded

xml=%3C%3Fxml+version%3D%221.0%22%3F%3E%3Cquery%3E%3Caction%3E%[Action]%3C%2Faction%3E%3Cuserid%3E[UserID]%3C%2Fuserid%3E%3Cuserkey%3E[UserKey]%3C%2Fuserkey%3E%3C%2Fquery%3E

POST https://manage.encoding.com/ HTTP/2
Host: manage.encoding.com
Content-Type: application/x-www-form-urlencoded

json=%7B%22query%22%3A%7B%22action%22%3A%22[Action]%22%2C%22userid%22%3A%22[UserID]%22%2C%22userkey%22%3A%22[UserKey]%22%7D%7D

The server response will be a normal XML document or JSON string, matching the type of document used in the request.
Please URL-encode any special characters in source or destination URL paths discretely (S3 secrets tend to be the case this is needed most often),

Support for non-TLS HTTP requests are deprecated and will be removed in a future platform update.