Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create rest-api.md - an overview of all REST API versions #383

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions Publisher/en/rest-api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# REST API Overview

The Copernica REST API has multiple versions. This page contains information
and links for all versions, along with some details about changes in each version.

The newest version of the API is version 4, which is the recommended version
to use. However, all of the previous versions are still operational. Here is
a list of all REST API versions:

* [REST API v4](./restv4/rest-api.md)
* [REST API v3](./restv3/rest-api.md)
* [REST API v2](./restv2/rest-api.md)
* [REST API v1](./restv1/rest-api.md)


## REST API v4

Version 4 of the API uses JWT authorization and contains additional endpoints.

More details about this version can be found [here](./restv4/rest-introduction.md).

### REST API v3

Version 3 of the API contains additional endpoints and some improvments over
the previous version.

More details about this version can be found [here](./restv3/rest-introduction.md).

### REST API v2

Version 2 of the REST API contains improvments, extra endpoints and
separate sections for Publisher and Marketing Suite.

More details about this version can be found [here](./restv2/rest-introduction.md).

### REST API v1

The initial, version 1, of the Copernica REST API. It is considered outdated,
but is still operational.

More details about this version can be found [here](./restv1/rest-introduction.md).