Skip to content
PIMS Open API

Authentication

Authenticate to the PIMS Open API with server-side credentials and HTTP Basic Auth, identify your tenant, and manage API keys.

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

For new integrations, use HTTPS and HTTP Basic Auth: send an Authorization: Basic <base64(apiID:apiSecret)> header. Both values are validated against your tenant's API settings on every call.

Keep keys on your server. Do not include them in browser code, mobile app bundles, or query strings. URLs can be retained in logs and browser history.

Existing integrations can continue using apiID and apiSecret query parameters where supported. Some existing endpoints also accept body parameters; the new Pending SRO JSON body accepts only its documented intake fields. Use Basic Auth for all new integrations.

A missing or incorrect credential returns 401 Unauthorized.

Required: teamID

Every request must include your tenant identifier as a teamID query parameter. Some existing endpoints also accept it in the body. For Pending SROs and SRO reads, always put teamID in the query string. A request with a missing or unknown teamID currently fails with a 500 server error, and the body may not be JSON. Check that teamID is set before you send a request.

Obtaining your API keys

  1. Log into the Weevio Cloud dashboard.
  2. Go to Developer Settings → API Settings.
  3. Select Replace Keys, then Save.
  4. 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'

Authentication errors

StatusWhen
401The API ID or API Secret is missing or invalid, or no API keys are configured for the tenant.
500The teamID parameter is missing or unknown. The body may not be JSON.