Getting Started

English only

Getting Started

  • All API requests are processed through GraphQL.
  • Authentication requires a valid OAuth token.
  • The endpoint URL contains your organization name.
  • Required headers: Authorization, Content-Type
  • You can test with Postman or a GraphQL client.

API Base URL

For each organization, the GraphQL endpoint looks like this:

https://[organization].pluvo.com/graphql/

The trailing slash is required.

Headers

Set the following headers for each request:

Authorization: Bearer <access_token>
Content-Type: application/json

Tokens are valid for a limited time. Ensure automatic renewal via the OAuth token endpoint.

Authentication: summary

To authenticate:

  1. Request an access token via:
    POST https://[organization].pluvo.com/oauth/token/
  2. Use the body (form-urlencoded):
  3. Use the token in the Authorization header for each request.

Version Management

The Pluvo API is stable. Breaking changes are avoided. New fields are added without removing old ones. There is no explicit versioning of the GraphQL API.

Test Environment

There is no public sandbox. Use your own organization environment and a separate test client with limited permissions. For structural test integrations, contact support.

Rate Limits

Standard rate limits apply per API client. Excessive requests are restricted. For bulk operations or peak traffic, specific arrangements can be made.

Schließ die Richtung