Ένα καθολικό API για κάθε ροή εργασίας αρχείων

Αυτό το τελικό σημείο είναι ανοιχτό, ώστε οι προγραμματιστές να μπορούν να εξετάσουν τον καθολικό κατάλογο μετατροπών πριν ζητήσουν ή ρυθμίσουν ένα κλειδί API.

curl "https://api.converter.app/public/pairs"

JavaScript

const response = await fetch('https://api.converter.app/public/pairs');
const pairs = await response.json();
console.log(pairs.supported_pairs);

Python

import requests

response = requests.get('https://api.converter.app/public/pairs')
response.raise_for_status()
pairs = response.json()
print(pairs['supported_pairs'])

Παράδειγμα απάντησης

{
  "supported_pairs": [
    { "from": "mp3", "to": "text" },
    { "from": "mp4", "to": "mp3" },
    { "from": "mov", "to": "mp4" },
    { "from": "wav", "to": "mp3" },
    { "from": "mkv", "to": "mp4" }
  ]
}

Χρησιμοποιήστε σύγχρονη μετατροπή όταν θέλετε άμεσο αποτέλεσμα στην ίδια απόκριση HTTP. Το αίτημα παραμένει ανοιχτό ενώ το API ξεκινά την εργασία μετατροπής και περιμένει την ολοκλήρωσή της, έως και 30 λεπτά.

curl -X POST "https://api.converter.app/convert/sync" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "target_format=pdf" \
  -F "files=@/path/to/document.docx" \
  -o converted.pdf

JavaScript

const form = new FormData();
form.append('target_format', 'pdf');
form.append('files', fileInput.files[0]);

const response = await fetch('https://api.converter.app/convert/sync', {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey
  },
  body: form
});

const convertedFile = await response.blob();

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
data = {'target_format': 'pdf'}

with open('/path/to/document.docx', 'rb') as document:
    files = {'files': document}
    response = requests.post(
        'https://api.converter.app/convert/sync',
        headers=headers,
        data=data,
        files=files
    )

response.raise_for_status()
with open('converted.pdf', 'wb') as output:
    output.write(response.content)

Η απάντηση μεταδίδει απευθείας το μετατρεπόμενο αρχείο. Εάν η μετατροπή παράγει πολλά αρχεία, το API επιστρέφει ένα αρχείο .zip.

Χρησιμοποιήστε ασύγχρονη μετατροπή για μεγάλα αρχεία, μαζική επεξεργασία, εργασίες ήχου ή βίντεο μεγάλης διάρκειας ή εφαρμογές παραγωγής που δεν πρέπει να διατηρούν ανοιχτά τα αιτήματα μεταφόρτωσης όσο εκτελείται η εργασία.

cURL

curl -X POST "https://api.converter.app/convert" \
  -H "X-API-Key: YOUR_API_KEY" \
  -F "target_format=mp3" \
  -F "files=@/path/to/video.mp4"

JavaScript

const form = new FormData();
form.append('target_format', 'mp3');
form.append('files', fileInput.files[0]);

const response = await fetch('https://api.converter.app/convert', {
  method: 'POST',
  headers: {
    'X-API-Key': apiKey
  },
  body: form
});

const job = await response.json();
console.log(job.jobid, job.remaining_quota);

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
data = {'target_format': 'mp3'}

with open('/path/to/video.mp4', 'rb') as video:
    files = {'files': video}
    response = requests.post(
        'https://api.converter.app/convert',
        headers=headers,
        data=data,
        files=files
    )

response.raise_for_status()
job = response.json()
print(job['jobid'], job['remaining_quota'])

Απόκριση επιτυχίας

{
  "status": "success",
  "jobid": "b3f6b2e8f5c34c4ab01c93c4d1b2f9e8",
  "pair": "mp42mp3",
  "remaining_quota": 42
}

Κάντε polling σε αυτό το endpoint μετά τη δημιουργία μιας ασύγχρονης εργασίας. Επιστρέφει την κατάσταση της εργασίας, μια αριθμητική τιμή προόδου από 0.0 έως 1.0 και λεπτομέρειες σφάλματος αν η μετατροπή απέτυχε.

curl "https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const response = await fetch('https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8', {
  headers: {
    'X-API-Key': apiKey
  }
});

const progress = await response.json();
console.log(progress.status, progress.progress);

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
response = requests.get(
    'https://api.converter.app/progress/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8',
    headers=headers
)
response.raise_for_status()
progress = response.json()
print(progress['status'], progress['progress'])

{
  "jobid": "b3f6b2e8f5c34c4ab01c93c4d1b2f9e8",
  "progress": 1.0,
  "status": "completed",
  "error": null
}

Οι δυνατές καταστάσεις είναι processing, completed και failed. Η πρόοδος είναι ένας αριθμός μεταξύ 0.0 και 1.0.

Μόλις μια ασύγχρονη εργασία φτάσει στην κατάσταση completed, ανακτήστε το μετατρεπόμενο αποτέλεσμα με το ίδιο API key που χρησιμοποιήθηκε για τη δημιουργία της εργασίας.

curl -L "https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8" \
  -H "X-API-Key: YOUR_API_KEY" \
  -o converted-output.zip

JavaScript

const response = await fetch('https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8', {
  headers: {
    'X-API-Key': apiKey
  }
});

const file = await response.blob();

Python

import requests

headers = {'X-API-Key': 'YOUR_API_KEY'}
response = requests.get(
    'https://api.converter.app/download/b3f6b2e8f5c34c4ab01c93c4d1b2f9e8',
    headers=headers
)
response.raise_for_status()

with open('converted-output.zip', 'wb') as output:
    output.write(response.content)