Metadata-Version: 2.4
Name: kiban-link
Version: 1.0.0
Summary: Link API
Home-page: https://github.com/kiban-cloud/kiban-sdk
Author: kiban
Author-email: kiban <hola@kiban.com>
License-Expression: Apache-2.0
Project-URL: Repository, https://github.com/kiban-cloud/kiban-sdk
Keywords: kiban,link,sdk,api
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: NOTICE
Requires-Dist: urllib3<3.0.0,>=2.6.3
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# kiban-link
Servicios de consulta y validación de kiban (CURP, SAT, IMSS, Buró, etc.) y administración de credenciales. En sandbox (sandbox.link.kiban.com) las ejecuciones responden test cases en lugar de llamar al proveedor.

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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](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:

```sh
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:
```python
import kiban.link
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import kiban.link
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import kiban.link
from kiban.link.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://link.kiban.com
# See configuration.py for a list of all supported configuration parameters.
configuration = kiban.link.Configuration(
    host = "https://link.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.link.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = kiban.link.LinkApi(api_client)
    service = 'service_example' # str | Servicio del catálogo (p. ej. curp, sat, imss, bc_pf)
    subservice = 'subservice_example' # str | Operación del servicio (p. ej. validate, query)
    body = None # object | Datos del servicio; cada servicio define sus campos
    sandbox = True # bool | Modo sandbox. Tiene que coincidir con el modo de la API key: una key de sandbox exige sandbox=true y una de producción no lo acepta. Se ignora en el host sandbox, donde ya es implícito (optional)
    test_case = 'test_case_example' # str | Sandbox: nombre del test case que debe responder (optional)
    test_case_id = 'test_case_id_example' # str | Sandbox: id del test case que debe responder (optional)
    origin = 'origin_example' # str | Identificador libre del origen de la petición (optional)

    try:
        # Ejecutar un servicio de link
        api_response = api_instance.execute_service(service, subservice, body, sandbox=sandbox, test_case=test_case, test_case_id=test_case_id, origin=origin)
        print("The response of LinkApi->execute_service:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling LinkApi->execute_service: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://link.kiban.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*LinkApi* | [**execute_service**](docs/LinkApi.md#execute_service) | **POST** /api/v3/{service}/{subservice} | Ejecutar un servicio de link
*LinkApi* | [**get_execution**](docs/LinkApi.md#get_execution) | **GET** /api/v1/{service}/{subservice}/{id} | Detalle de una ejecución
*LinkApi* | [**get_file**](docs/LinkApi.md#get_file) | **GET** /api/v1/file | Descargar un archivo de una ejecución
*LinkApi* | [**list_executions**](docs/LinkApi.md#list_executions) | **GET** /api/v1/{service}/{subservice} | Historial de ejecuciones de un servicio
*LinkApi* | [**list_test_cases**](docs/LinkApi.md#list_test_cases) | **GET** /api/v3/{service}/{subservice}/test_case | Test cases de un servicio
*VaultApi* | [**create_vault**](docs/VaultApi.md#create_vault) | **POST** /api/v3/vault/na | Crear una credencial
*VaultApi* | [**delete_vault**](docs/VaultApi.md#delete_vault) | **DELETE** /api/v3/vault/na/{id} | Borrar una credencial
*VaultApi* | [**get_vault**](docs/VaultApi.md#get_vault) | **GET** /api/v1/vault/na/{id} | Detalle de una credencial
*VaultApi* | [**list_vaults**](docs/VaultApi.md#list_vaults) | **GET** /api/v1/vault/na | Listar credenciales
*VaultApi* | [**update_vault**](docs/VaultApi.md#update_vault) | **PUT** /api/v3/vault/na/{id} | Editar una credencial
*VaultApi* | [**validate_vault**](docs/VaultApi.md#validate_vault) | **POST** /api/v3/{service}/{subservice}/vault | Validar una credencial para un servicio


## Documentation For Models

 - [ControllerMicroserviceModelApiDataDetailDto](docs/ControllerMicroserviceModelApiDataDetailDto.md)
 - [ControllerMicroserviceModelApiDataEventDto](docs/ControllerMicroserviceModelApiDataEventDto.md)
 - [ControllerMicroserviceModelApiDataFileDto](docs/ControllerMicroserviceModelApiDataFileDto.md)
 - [ControllerMicroserviceModelApiDataHttpDto](docs/ControllerMicroserviceModelApiDataHttpDto.md)
 - [ControllerMicroserviceModelEventDto](docs/ControllerMicroserviceModelEventDto.md)
 - [ControllerMicroserviceModelExecutionPage](docs/ControllerMicroserviceModelExecutionPage.md)
 - [ControllerMicroserviceModelMicroserviceDetailDto](docs/ControllerMicroserviceModelMicroserviceDetailDto.md)
 - [ControllerMicroserviceModelMicroserviceResumeDto](docs/ControllerMicroserviceModelMicroserviceResumeDto.md)
 - [ControllerMicroserviceModelValidationErrorDto](docs/ControllerMicroserviceModelValidationErrorDto.md)
 - [ControllerMicroserviceModelVaultNameDto](docs/ControllerMicroserviceModelVaultNameDto.md)
 - [ControllerMicroserviceModelVaultValidationDto](docs/ControllerMicroserviceModelVaultValidationDto.md)
 - [ControllerTestCaseModelTestCaseOutputMany](docs/ControllerTestCaseModelTestCaseOutputMany.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth

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


## Author

hola@kiban.com


