All Collections
API
Getting Started - RESTful API
Getting Started - RESTful API

Getting started with our RESTful API is easy. You’ll need an account at Shipmondo, as well as an API username and an API key.

Nicklas Nguyen avatar
Written by Nicklas Nguyen
Updated over a week ago

Shipmondo RESTful API is currently on v3.

Further information and documentation can be found here.

Getting started with the API – obtaining API access

Getting started with our RESTful API is easy. You’ll need an account at Shipmondo, as well as an API username and an API key.

A free account can be created here, and once the account is created and you’re logged in, the API username and key can be generated from the API settings page, Settings > API > Access.

Authentication

You need to use HTTP Basic Authentication in order to make requests to the API.

The generated API User and API Key must be included in every calls to the API.
For example, if you have Aladdin as the username and OpenSesame as the password, then the field’s value is the base64-encoding of Aladdin:OpenSesame, or QWxhZGRpbjpPcGVuU2VzYW1l. Then the Authorization header will appear as:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l

The complete technical documentation including all API methods can be found here.

Printing of shipping labels

For choosing of printer to output your labels from the API you need to install Shipmono Printklient. You can find the installation guide here.

Did this answer your question?