kiban-workfloo

API pública de Workfloo: ejecuta un workfloo, consulta su estatus y revisa el historial/detalle de ejecuciones. Todos los endpoints se autentican con el header x-api-key.

Ambientes: producción en https://workfloo.kiban.com y sandbox en https://sandbox.workfloo.kiban.com. El host sandbox activa ese modo de forma implícita y tiene precedencia: ahí el query param sandbox se ignora. Desde el host de producción se puede forzar el modo sandbox por request con sandbox=true.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0
• Package version: 1.0.0
• Generator version: 7.24.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://kiban.com

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/kiban-cloud/kiban-sdk.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/kiban-cloud/kiban-sdk.git)

Then import the package:

import kiban.workfloo

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import kiban.workfloo

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import kiban.workfloo
from kiban.workfloo.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://workfloo.kiban.com
# See configuration.py for a list of all supported configuration parameters.
configuration = kiban.workfloo.Configuration(
    host = "https://workfloo.kiban.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'


# Enter a context with an instance of the API client
with kiban.workfloo.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kiban.workfloo.PoolApi(api_client)
    controller_pool_model_execute = kiban.workfloo.ControllerPoolModelExecute() # ControllerPoolModelExecute | Definición del pool y escenarios
    sandbox = True # bool | Fuerza el ambiente sandbox. Se ignora en el host sandbox, donde ya es implícito (optional)

    try:
        # Ejecutar un pool
        api_response = api_instance.execute_pool(controller_pool_model_execute, sandbox=sandbox)
        print("The response of PoolApi->execute_pool:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling PoolApi->execute_pool: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://workfloo.kiban.com

Documentation For Models

• ControllerPoolModelExecute
• ControllerPoolModelExecuteResponse
• ControllerWorkflooDefinitionModelAutoFilledBy
• ControllerWorkflooDefinitionModelDocument
• ControllerWorkflooDefinitionModelField
• ControllerWorkflooDefinitionModelFieldMetadata
• ControllerWorkflooDefinitionModelFieldValidator
• ControllerWorkflooDefinitionModelFileDocument
• ControllerWorkflooDefinitionModelFileDocumentSet
• ControllerWorkflooDefinitionModelFileMetadata
• ControllerWorkflooDefinitionModelForm
• ControllerWorkflooDefinitionModelFormFieldSection
• ControllerWorkflooDefinitionModelSetData
• ControllerWorkflooDefinitionModelSetDataDocument
• ControllerWorkflooDefinitionModelShow
• ControllerWorkflooDefinitionModelShowIf
• ControllerWorkflooModelApi
• ControllerWorkflooModelApiData
• ControllerWorkflooModelApiDataResume
• ControllerWorkflooModelApiHttp
• ControllerWorkflooModelData
• ControllerWorkflooModelDecisionTree
• ControllerWorkflooModelDocumentsResume
• ControllerWorkflooModelEvent
• ControllerWorkflooModelExecute
• ControllerWorkflooModelExecuteResponse
• ControllerWorkflooModelFile
• ControllerWorkflooModelFileResponse
• ControllerWorkflooModelFileResponseV2
• ControllerWorkflooModelForm
• ControllerWorkflooModelFormField
• ControllerWorkflooModelFormResume
• ControllerWorkflooModelLabel
• ControllerWorkflooModelLink
• ControllerWorkflooModelLinkNipStatus
• ControllerWorkflooModelLinkResume
• ControllerWorkflooModelNipResendRequest
• ControllerWorkflooModelNipResendStatus
• ControllerWorkflooModelNipSendErrorStatus
• ControllerWorkflooModelNipSendRequest
• ControllerWorkflooModelNipValidateRequest
• ControllerWorkflooModelNipValidateResponse
• ControllerWorkflooModelNode
• ControllerWorkflooModelNodeDetail
• ControllerWorkflooModelNodeResume
• ControllerWorkflooModelOtpValidateRequest
• ControllerWorkflooModelPdf
• ControllerWorkflooModelRemainingTime
• ControllerWorkflooModelReviewFieldRequest
• ControllerWorkflooModelReviewRequest
• ControllerWorkflooModelReviewResume
• ControllerWorkflooModelRules
• ControllerWorkflooModelRuleset
• ControllerWorkflooModelTimer
• ControllerWorkflooModelValidateFieldRequest
• ControllerWorkflooModelValidateFieldResponse
• ControllerWorkflooModelValidationField
• ControllerWorkflooModelValidationResume
• ControllerWorkflooModelValidationStatus
• ControllerWorkflooModelVariable
• ControllerWorkflooModelVariables
• ControllerWorkflooModelVerificationStatus
• ControllerWorkflooModelWorkfloo
• ControllerWorkflooModelWorkflooListItem
• ControllerWorkflooModelWorkflooPage
• ControllerWorkflooModelWorkflooResume
• ControllerWorkflooModelWorkflooStatus

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author

hola@kiban.com