Skip to main content

Server API

Using the Shipbook Web API (Application Programming Interface)​

By making certain APIs public, Shipbook allowing you the flexibility to use the logs any way you want!

What are APIs?​

APIs are the messenger that will take your external request, or the request made on the console, and deliver that request to our server. This very API will then act as the very messenger who will take the server’s response back to you!

Deploy Tracking from CI​

A common use of the API is telling Shipbook about a deploy from your build pipeline, so the Releases page and the Bridge deploy markers carry the exact deploy time:

curl -X POST https://api.shipbook.io/v2/apps/<appId>/releases \
  -H "Authorization: Bearer <auth key>" \
  -H "Content-Type: application/json" \
  -d '{"version": "2.4.0", "notes": "Checkout redesign"}'

version is required; deployedAt (ISO date, defaults to now) and notes are optional. Create the auth key under Authentication Keys. Posting the same version again updates it, so the call is safe to keep in your pipeline.

Free API List​

Here is a list of free APIs that are open for use with Shipbook software for app programming and development.

Take a deeper look at the APIs that are available to the public at Shipbook: