Shipstar

Connect your client's Shipstar with a key they paste, and call its API through Operate As.

Connects by
Pasting a API key
Category
Email
Services
1
Tools
Pass-through only
ServiceKey
Shipstarshipstar

Connecting

Your client makes a API key in their Shipstar settings and pastes it on their link. Operate As tries it with Shipstar before saving it, and stores it encrypted. See Services connected with an API key.

Check they're connected
curl https://api.operate.as/v1/me/clients \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"
Response
[  {    "id": "6f1c2a7e-...",    "name": "Miller Dental",    "services": [      "shipstar"    ]  }]

Permissions

What the client readsPermission it asks for
Use the Shipstar key you paste, with only the access you gave that keyChosen on the provider's screen

Pass-through

Shipstar has no ready-made tools yet. Call any endpoint of its API through Operate As instead, with the client's access attached.

Add the client

In Clients, add your client and select Shipstar. Then send them their link.

Your client connects

They paste a API key from their Shipstar settings.

Find the endpoint

Pick the call from Shipstar's own API docs. Your path is everything after https://api.shipstar.ai.

Send it through Operate As

Use the client's ID, the service key shipstar and that path. Your Operate As key goes in Authorization; the client's access is added for you.

See Pass-through requests for the full request and response format.

Call any endpoint
curl "https://api.operate.as/v1/clients/6f1c2a7e-.../shipstar/api/v1/me" \  -H "Authorization: Bearer $OPERATE_AS_API_KEY"
Response
{  "status": 200,  "data": {    "…": "the service's own response"  },  "encoding": "json"}

When access ends

A key works until your client deletes it in Shipstar. They can paste a new one on the same link at any time, and your workflows carry on without changes.

See Keeping access alive and Removing access.

Calls answer, once the key is deleted
{  "status": 401,  "data": {    "…": "the service's own error"  },  "encoding": "json"}