Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Weavr Manage API

The Manage API from Weavr — 7 operation(s) for manage.

Weavr Manage API is one of 43 APIs that Weavr publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Manage. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 7 operations across 7 paths, and defines 15 schemas. It is described by OpenAPI 3.1.0, at version v3.

Requests are made against a single base URL, https://sandbox.weavr.io/multi/backoffice.

7 operations 7 paths 15 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v3
Base URL
https://api.weavr.io/multi
Authentication
API Key, HTTP Bearer
Contact
Resource Areas
1

Authentication & Security 2

Weavr Manage API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (api_key). It accepts HTTP bearer tokens (JWT) (auth_token).

  • api_key — The API Key representing your Multi account.
  • auth_token — The authentication token representing the user. This will be included in the login response object.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Manage 7
GET
/bulks
Get all bulk processes
bulks 3 params → 200400401403404409500503
GET
/bulks/{bulk_id}
Get bulk process
bulkId 1 param → 200400401403404500503default
GET
/bulks/{bulk_id}/operations
Get all operations in a bulk
bulkIdOperations 5 params → 200400401403404500503default
POST
/bulks/{bulk_id}/execute
Execute bulk process
bulkIdExecute 1 param body → 204400401403404409500503
POST
/bulks/{bulk_id}/pause
Pause bulk process
bulkIdPause 1 param → 204400401403404409500503
POST
/bulks/{bulk_id}/resume
Resume bulk process
bulkIdResume 1 param → 204400401403404409500503
POST
/bulks/{bulk_id}/cancel
Cancel bulk process
bulkIdCancel 1 param → 204400401403404409500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are BulkProcessOperation (7 properties), BulkProcess (7 properties), BulkProcessesPaged (3 properties), BulkProcessOperationsPaged (3 properties). Each schema is shown below with its type and property counts.

BulkProcessConflict
object
1 property
SyntaxError
object
Is returned as part of an HTTP error response whenever a syntax error is detected. A list of the fields together with their syntax error will be provided.
1 property
BulkId
string
BulkProcessOperationStatus
string
BulkProcessOperationStatusCounts
object
2 properties
BulkProcessesPaged
object
3 properties
BulkProcessOperation
object
7 properties
BulkProcess
object
7 properties
BulkProcessDetails
BulkProcessMode
string
ONFAILURESTOP : the execution of the bulk process stops after the first bulk operation that fails (operation returns a 4xx or 5xx response code). ONFAILURECONT…
BulkProcessExecute
object
2 properties
BulkProcessOperationsPaged
object
3 properties
BulkProcessStatus
string
Error
object
2 properties
BulkProcessConflictErrorCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weavr-manage-api-openapi.yml Raw ↑

Other APIs Weavr publishes across the network.

Weavr Access Token API
Weavr Access Tokens API
Weavr Accounts API
Weavr Additional Factors API
Weavr Authentication Factors API
Weavr Authorised Signatories API
Weavr Authorised Users API
Weavr Buyer Authorised Users API
Weavr Buyers API
Weavr Card Payments API
Weavr Cards API
Weavr Confirmation Challenges API