Getting started

PoS API in a nutshell

PoS API is a REST API in JSON, that allows retail partners to rent out and take back powerbanks at their point of sale.

The API is available in a sandbox and a production environment.

The endpoints are built around 3 resources:

1. Batteries: check whether a given power bank can be rented out or returned. N.B.: this check is optional.
2. Users: check whether a given user coupon is valid and leads a special deal and / or to an in-app payment. N.B: this check is optional.
3. Rentals: get pricing information and/or create a rental for a given battery, location and eventually user coupon

Each endpoint can only be used if the request is authorized.

Quick start with Postman

Any recent HTTP client can be used to interact with the Chimpy POS API (curl, wget, ruby net/http, node http, etc.). However, the quickest way to get started - without writing a single line of code or handling any configuration - is to use the readymade Postman collection built for Chimpy's PoS API.

1. Download Postman (or update your existing version with the latest one)
2. Log in with the Postman credentials provided by Chimpy to access the collection
3. Select team workspace Chimpy and environment Chimpy Sandbox in Postman
4. Get a valid access_token (JWT) by calling the endpoint available under Auth folder. The access_token will be automatically saved and added to the requests to the following step. See Authorization & Authentication for further information.
5. Play with the different endpoints under the resources folders (Batteries, Users, Rentals). If a HTTP 401 Unauthorized response is returned by the Chimpy POS API, repeat step 4. See Batteries, Users, Rentals for further information.