Use the API with a service account

🗂️ Connect another system to Vyer with a service account, a member that signs in to the API with a token and has a role like anyone else.

You need the Admin or Owner role.

Create the account

  1. Open Organization settings, click Members and then Create a service account. Give it a Name that says which system it is for, and click Create service account.

  2. The Edit service account dialog opens with the Token filled in. Click the copy button and store the token where the other system can read it. It is shown this once.

  3. Set the Role. A new service account is an Editor on every site. Narrow it like any member, to fewer sites or to reading only, and click Update. See Limit a member to some sites.

The account appears in the members list with a robot icon.

Call the API

The other system sends GraphQL requests to https://app.vyer.com/graphql with the header Authorization: Bearer followed by the token. It sees and changes exactly what its role allows, and its changes show up in the activity log under the account's name. A token is valid for 10 years. Contact support for the API reference; see Reach us from the app.

Replace a lost or leaked token

  1. In the members list, choose Edit service account in the row menu.

  2. Click the refresh button next to Token and confirm Generate new token. The old token stops working at once.

  3. Copy the new token into the other system.

A service account cannot be removed from the organization. To cut a system off, generate a new token and keep it to yourself, or set the role to Viewer.

If it doesn't work

The copy button says Regenerate to copy

The token is shown only right after it is created or regenerated. Generate a new one and copy it then.

Requests are answered with Token has been revoked

Someone generated a new token for the account. Use the new one.

There is no Create a service account button

Only Admins and Owners create service accounts.

Next

Axel Buhlmann

Axel Buhlmann

Customer Success Manager

Can’t find what you’re looking for?

Our support team is happy to help you get unstuck.