Introduction

Introduction

Overview

What is REST API? To make it simple, REST API defines a set of functions to which the developers can perform requests and receive responses. The interaction is performed via the HTTP protocol. An advantage of such an approach is the wide usage of HTTP. That is why REST API can be used practically for any programming language. Common characteristics of Yumpu REST API resources are as follows:

  • You access the resource by sending an HTTP request to the API server. The server replies with a response that contains either the data you requested, or the status indicator, or even both.

  • All resources are located at https://api.yumpu.com/2.0.

  • All resources may return different HTTP status codes (e.g., HTTP Status Code 200 for success response or HTTP Status Code 400 for the bad request).

  • You request a particular resource by adding a particular path to the base URL that specifies the resource.

Output formats

The REST API supports the response in two formats, which are JSON or XML.

HTTP verbs

HTTP verbs are used to manage the state of resources. In REST API, there are four verbs used to manage resources: GET, POST, PUT and DELETE. You can get the contents of the data using HTTP GET, delete the data using HTTP DELETE, and create or update the data using POST/PUT.

HTTP status codes

200 OK

Standard response for successful HTTP requests.

202 Accepted

The request has been accepted for processing, but the processing has not been completed.

400 Bad Request

The request cannot be fulfilled due to bad syntax.

401 Unauthorized

Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided.

403 Forbidden

The request was a valid request, but the server is refusing to respond to it.

404 Not Found

The requested resource could not be found but may be available again in the future.

500 Internal Server Error

A generic error message, given when no more specific message is suitable.

505 HTTP Version Not Supported

The server does not support the HTTP protocol version used in the request.

Request URL

All URLs in REST API have the following base URL: https://api.yumpu.com/2.0.

Resources

Get

Retrieve a list of your documents.

Get

Retrieve an existing document.

Post

Create a new document by URL or file.

Put

Update an existing document.

Delete

Delete an existing document.

Get

Retrieve the current progress of your document.

Get

Retrieve a list of our categories.

Get

Retrieve a list of your collections.

Get

Retrieve an existing collection.

Post

Create a new collection.

Put

Update an existing collection.

Delete

Delete an existing collection.

Get

Retrieve an existing section.

Post

Create a new section.

Put

Update an existing section.

Delete

Delete an existing section.

Post

Create a new section.

Delete

Delete an existing section.

Get

Search our index and retrieve a list of documents.

Authentication

All methods require authentication. Your access token must be sent in the HTTP header as X-ACCESS-TOKEN: ACCESS_TOKEN.

Limits

Limits per window by resource. Rate limit window duration is currently 15 minutes long. More details: Limits