DokumentationDynamic Media Image Production System API

Överföra resurser via HTTP POST till UploadFile-servern uploading-assets-by-way-of-http-posts-to-the-uploadfile-servlet

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

När du överför resurser till Dynamic Media Classic måste du ange en eller flera HTTP-POSTER som ställer in ett jobb för att koordinera all loggaktivitet som är kopplad till de överförda filerna.

Använd följande URL för att komma åt UploadFile-servern:

https://<server>/scene7/UploadFile
NOTE
Alla POSTER som begär ett överföringsjobb måste komma från samma IP-adress.

Åtkomst-URL:er för Dynamic Media-regioner

Geografisk plats
Produktions-URL
Mellanlagrings-URL (används för utveckling och testning av förproduktion)
Nordamerika
https://s7sps1ssl.scene7.com/scene7/UploadFile
https://s7sps1ssl-staging.scene7.com/scene7/UploadFile
Europa, Mellanöstern, Asien
https://s7sps3ssl.scene7.com/scene7/UploadFile
https://s7sps3ssl-staging.scene7.com/scene7/UploadFile
Japan/Asien/Stillahavsområdet
https://s7sps5ssl.scene7.com/scene7/UploadFile
https://s7sps5ssl-staging.scene7.com/scene7/UploadFile

Överföringsjobbets arbetsflöde section-873625b9512f477c992f5cdd77267094

Överföringsjobbet består av en eller flera HTTP POST som använder en gemensam jobHandle för att korrelera bearbetningen till samma jobb. Varje begäran är multipart/form-data-kodad och består av följande formulärdelar:

NOTE
Alla POSTER som begär ett överföringsjobb måste komma från samma IP-adress.
Formulärdel för HTTP-POST
Beskrivning
auth
Obligatoriskt. Ett XML authHeader-dokument som anger autentisering och klientinformation. Se Begär autentisering under SOAP.
file params
Valfritt. Du kan inkludera en eller flera filer som ska överföras vid varje begäran om POST. Varje fildel kan innehålla en filnamnsparameter i Content-Disposition-huvudet som används som målfilnamn i IPS om ingen uploadPostParams/fileName-parameter har angetts.
Formulärdel för HTTP-POST
uploadPostParams-elementnamn
Typ
Beskrivning
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
companyHandle
xsd:string
Obligatoriskt. Hantera till det företag som filen överförs till.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
jobName
xsd:string
Antingen jobName eller jobHandle krävs. Namn på överföringsjobbet.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
jobHandle
xsd:string
Antingen jobName eller jobHandle krävs. Hantera ett överföringsjobb som har startats i en tidigare begäran.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
locale
xsd:string
Valfritt. Språk- och landskod för lokalisering.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
description
xsd:string
Valfritt. Beskrivning av jobbet.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
destFolder
xsd:string
Valfritt. Sökväg till målmappen om du vill lägga till prefix till en filename-egenskap, särskilt för webbläsare och andra klienter som inte har stöd för fullständiga sökvägar i ett filnamn.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
fileName
xsd:string
Valfritt. Målfilens namn. Åsidosätter filename-egenskapen.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
endJob
xsd:boolean
Valfritt. Standardvärdet är false.
uploadParams (obligatoriskt. Ett XML uploadParams-dokument som anger överföringsparametrarna)
uploadParams
types:UploadPostJob
Valfritt om detta är en efterföljande begäran för ett befintligt aktivt jobb. Om det finns ett befintligt jobb ignoreras uploadParams och de befintliga jobböverföringsparametrarna används. Se UploadPostJob

I blocket <uploadPostParams> är det <uploadParams>-block som anger bearbetningen av de inkluderade filerna.

Se UploadPostJob.

Du kan anta att parametern uploadParams kan ändras för enskilda filer som en del av samma jobb, men så är inte fallet. Använd samma uploadParams-parametrar för hela jobbet.

Den initiala POSTEN för ett nytt överföringsjobb bör ange parametern jobName, helst med ett unikt jobbnamn för att förenkla efterföljande jobbstatusavsökningar och jobbloggfrågor. Ytterligare POSTER för samma överföringsjobb ska ange parametern jobHandle i stället för jobName, med det jobHandle-värde som returneras från den ursprungliga begäran.

Den sista POSTEN för ett överföringsjobb ska ange parametern endJob till true så att inga framtida filer POSTed för det här jobbet skickas. Detta innebär i sin tur att jobbet kan slutföras omedelbart efter att alla POSTed-filer har importerats. Annars går jobbet ut om inga fler begäranden om POST tas emot inom 30 minuter.

UploadPOST-svar section-421df5cc04d44e23a464059aad86d64e

För en begäran om lyckad POST är svarstexten ett XML uploadPostReturn-dokument, vilket anges i följande XSD:

<element name="uploadPostReturn">
        <complexType>
            <sequence>
                <element name="jobHandle" type="xsd:string"/>
            </sequence>
        </complexType>
    </element>

jobHandle som returneras skickas i parametern uploadPostParams/ jobHandle för efterföljande POSTER för samma jobb. Du kan också använda den för att avfråga jobbstatus med åtgärden getActiveJobs eller för att fråga jobbloggarna med åtgärden getJobLogDetails.

Om det uppstår ett fel när POSTEN bearbetas består svarstexten av en av API-feltyperna som beskrivs i Felmeddelanden.

Exempelbegäran om POST section-810fe32abdb9426ba0fea488dffadd1e

POST /scene7/UploadFile HTTP/1.1
User-Agent: Jakarta Commons-HttpClient/3.1
Host: localhost
Content-Length: 362630
Content-Type: multipart/form-data; boundary=O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="auth"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

            <authHeader xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
                   <user>sampleuser@test.com</user>
                   <password>*</password>
                   <locale>en-US</locale>
                   <appName>MyUploadServletTest</appName>
                   <appVersion>1.0</appVersion>
                   <faultHttpStatusCode>200</faultHttpStatusCode>
           </authHeader>

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ
Content-Disposition: form-data; name="uploadParams"
Content-Type: text/plain; charset=US-ASCII
Content-Transfer-Encoding: 8bit

            <uploadPostParam xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
                <companyHandle>c|2101</companyHandle>
                <jobName>uploadFileServlet-1376682217351</jobName>
                <uploadParams>
                    <overwrite>true</overwrite>
                    <readyForPublish>true</readyForPublish>
                    <preservePublishState>true</preservePublishState>
                    <createMask>true</createMask>
                    <preserveCrop>true</preserveCrop>
                    <manualCropOptions>
                      <left>500</left>
                      <right>500</right>
                      <top>500</top>
                      <bottom>500</bottom>
                    </manualCropOptions>
                    <photoshopOptions>
                      <process>MaintainLayers</process>
                      <layerOptions>
                        <layerNaming>AppendNumber</layerNaming>
                        <anchor>Northwest</anchor>
                        <createTemplate>true</createTemplate>
                        <extractText>true</extractText>
                        <extendLayers>false</extendLayers>
                      </layerOptions>
                    </photoshopOptions>
                    <emailSetting>None</emailSetting>
                </uploadParams>
            </uploadPostParam>

--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file1"; filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-1.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--
Content-Disposition: form-data; name="file2"; filename="ApiTestCo1/UploadFileServlet1376682217351//1376682217351-2.jpg"
Content-Type: application/octet-stream; charset=ISO-8859-1
Content-Transfer-Encoding: binary
<file bytes ... >
--O9-ba7tieRtqA4QRSaVk-eDq6658SPrYfvUcJ--

Exempel på svar från POSTEN - lyckad section-0d515ba14c454ed0b5196ac8d1bb156e

HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 204
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown

'1.0' encoding='UTF-8'?><uploadPostReturn xmlns="http://www.scene7.com/IpsApi/xsd/2014-04-03">
  <jobHandle>j|2101||uploadFileServlet-1376682217351|54091</jobHandle>
</uploadPostReturn>

Exempel på svar från POSTEN - fel section-efc32bb371554982858b8690b05090ec

HTTP/1.1 200 OK
Content-Type: text/xml;charset=utf-8
Content-Length: 210
Date: Mon, 25 Jul 2016 19:43:38 GMT
Server: Unknown

<?xml version='1.0' encoding='UTF-8'?><tns:authenticationFault xmlns:tns="http://www.scene7.com/IpsApi/xsd"><tns:code>10001</tns:code><tns:reason>Invalid username/password</tns:reason></tns:authenticationFault>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681