Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zamzar Imports API

Import files from an external URL, (S)FTP server or Amazon S3 bucket

Zamzar Imports API is one of 6 APIs that Zamzar publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Imports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and rate-limit docs.

This API exposes 3 operations across 2 paths, and defines 5 schemas. It is described by OpenAPI 3.0.3, at version 0.0.7.

Requests are made against 2 base URLs: https://api.zamzar.com/v1, https://sandbox.zamzar.com/v1.

3 operations 2 paths 5 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
0.0.7
Base URL
https://api.zamzar.com/v1/
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Zamzar Imports API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Imports 3

Import files from an external URL, (S)FTP server or Amazon S3 bucket

GET
/imports
Retrieve a list of all imports
listImports 3 params → 200504
POST
/imports
Start an Import
startImport body → 201
GET
/imports/{importId}
Retrieve a specific import
getImportById 1 param → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Import (8 properties), File (6 properties), PagingNumeric (4 properties), Failure (2 properties). Each schema is shown below with its type and property counts.

Imports
object
Contains a paged collection of import objects. Newer imports appear before older imports.
2 properties
PagingNumeric
object
4 properties
Import
object
Represents the process of copying a file from an external URL, (S)FTP server, or an Amazon S3 bucket.
8 properties 1 required
File
object
Represents a file which has been uploaded, imported or converted.
6 properties 2 required
Failure
object
If a process fails, the response will include a failure object to describe the error. If a process is either incomplete or successful, the failure object will…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zamzar-imports-api-openapi.yml Raw ↑

Other APIs Zamzar publishes across the network.

Zamzar Account API
Zamzar Files API
Zamzar Formats API
Zamzar Jobs API
Zamzar Welcome API