Quickstart

This page walks you from a freshly issued API secret to a verified, working request in a few minutes. The example uses simple authentication — once it's working, move on to HMAC request signing for production.

Before you start

You need:

• An API secret issued by the WeVideo API solutions team. (If you don't have one, contact us — the secret is tied to your partner Instance.)
• A terminal with curl, or any HTTP client.

Base URL

All public API endpoints live under:

https://www.wevideo.com/api/5

Every path in the API reference is relative to this base.

Make your first request

List the users in your Instance. This is a safe, read-only call that proves your credentials work end to end.

Request

curl https://www.wevideo.com/api/5/public/users \
  -H 'Authorization: WEVSIMPLE your-api-secret-here' \
  -H 'Accept: application/json'

Replace your-api-secret-here with the secret you were issued.

What success looks like

A successful call returns HTTP 200 and a JSON body shaped roughly like this:

Response

{
  "content": [
    {
      "id": 12345,
      "email": "jane@example.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "instanceId": 9876,
      "roles": ["admin"]
    }
  ],
  "totalElements": 1,
  "totalPages": 1,
  "number": 0,
  "size": 20
}

If you see a list of users from your Instance, your integration is correctly authenticated and pointed at the right environment. The exact fields are documented in GET /public/users.

If something went wrong

Status	Likely cause
401	The Authorization header is missing, malformed, or the secret is wrong.
403	The secret is valid but the user it represents is not an admin of the Instance.
404	The base URL or path is wrong — check for typos and the /api/5/ prefix.
5xx	A server-side issue. Retry once; if it persists, contact support.

For full status code coverage and an HMAC signing checklist, see Errors & troubleshooting.

Next steps

Now that your credentials work, the most common next steps are:

• Create a user in your Instance via POST /public/users.
• Generate a login token so an end user can sign in to WeVideo without a password.
• Embed the WeVideo editor in your own product as an iframe with SSO.
• Read about core entities — Instance, Super Instance, User — to understand how requests are scoped.

Once you're ready for production, switch from WEVSIMPLE to HMAC request signing so requests cannot be tampered with or replayed.