Skip to content

Marketplace Public Api

Operations Summary

Method Endpoint Description
POST /api/marketplace-public-api/check_signature/ Check service provider signature
POST /api/marketplace-public-api/set_usage/ Set component usage with signature

Check service provider signature

1
2
3
4
5
    Validates a signed payload from a service provider. The payload is a JWT token
    signed with the provider's API secret code. This endpoint is used to verify the
    authenticity of a request before processing it.

    The `data` field should contain the JWT token.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-public-api/check_signature/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  data="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_signature_request import ServiceProviderSignatureRequest # (1)
from waldur_api_client.api.marketplace_public_api import marketplace_public_api_check_signature # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderSignatureRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    data="string-value"
)
response = marketplace_public_api_check_signature.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderSignatureRequest
  2. API Source: marketplace_public_api_check_signature
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePublicApiCheckSignature } from 'waldur-js-client';

try {
  const response = await marketplacePublicApiCheckSignature({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "data": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
customer string (uuid) ✓ Service provider customer UUID
data string ✓ JWT-encoded data signed with the service provider's API secret code
dry_run boolean If true, validates the signature without executing the operation
Constraints: default: False

200 - No response body

Set component usage with signature

1
2
3
4
5
    Allows a service provider to report usage for resource components using a signed JWT payload.
    This provides a secure way for external systems to submit billing data.

    The `data` field must contain a JWT token that, when decoded, matches the structure of the
    `ComponentUsageCreateSerializer`.

1
2
3
4
5
6
http \
  POST \
  https://api.example.com/api/marketplace-public-api/set_usage/ \
  Authorization:"Token YOUR_API_TOKEN" \
  customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  data="string-value"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.service_provider_signature_request import ServiceProviderSignatureRequest # (1)
from waldur_api_client.api.marketplace_public_api import marketplace_public_api_set_usage # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = ServiceProviderSignatureRequest(
    customer="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    data="string-value"
)
response = marketplace_public_api_set_usage.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: ServiceProviderSignatureRequest
  2. API Source: marketplace_public_api_set_usage
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
import { marketplacePublicApiSetUsage } from 'waldur-js-client';

try {
  const response = await marketplacePublicApiSetUsage({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "customer": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "data": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
customer string (uuid) ✓ Service provider customer UUID
data string ✓ JWT-encoded data signed with the service provider's API secret code
dry_run boolean If true, validates the signature without executing the operation
Constraints: default: False

201 - No response body