Authentication

Every PIMS Open API request is authenticated with your tenant's API ID and API Secret, and must identify your tenant with a teamID.

Base URL

All endpoints live under:

https://cloud.weevio.co/tenant/api/pims/v1

Credentials

You can supply your API ID and API Secret in either of two ways. Both values are validated against your tenant's API settings on every call.

HTTP Basic Auth (recommended): send an Authorization: Basic <base64(apiID:apiSecret)> header.
Query or body parameters: include apiID and apiSecret in the request.

A missing or incorrect credential returns 401 Unauthorized.

Note:

Your API ID and API Secret are tenant-wide credentials. Keep them secret and rotate them if you suspect they've been exposed.

Required: `teamID`

Every request must include your tenant identifier as a teamID query (or body) parameter. A request without it returns 400 with Missing 'teamID' parameter!.

Obtaining your API keys

Log into the Weevio Cloud dashboard.
Go to Developer Settings → API Settings.
Select Replace Keys, then Save.
Copy your new API ID and API Secret and store them somewhere safe — the secret is shown to you here.

Example request

curl -s -u 'YOUR_API_ID:YOUR_API_SECRET' \
  'https://cloud.weevio.co/tenant/api/pims/v1/customers/single' \
  --get \
  --data-urlencode 'teamID=<YOUR-TEAM-ID>' \
  --data-urlencode 'customerCode=M-1000'

curl -s \
  'https://cloud.weevio.co/tenant/api/pims/v1/customers/single' \
  --get \
  --data-urlencode 'teamID=<YOUR-TEAM-ID>' \
  --data-urlencode 'apiID=YOUR_API_ID' \
  --data-urlencode 'apiSecret=YOUR_API_SECRET' \
  --data-urlencode 'customerCode=M-1000'

Authentication errors

Status	When
`401`	The API ID or API Secret is missing or invalid, or no API keys are configured for the tenant.
`400`	The `teamID` parameter is missing.

Note:

Every authenticated call to a PIMS Open API endpoint is metered and counts toward your monthly request total. See the overview for pricing.

Need Help?

For assistance, please send a message to our Support page.

PIMS Open API Customers