Documentación Api

Creación Organizaciones y Cuentas

Crear Organización

Información

Tip

Url de solicitud Api
{url}¹/v1/identity/organization/organization

Info

Para poder crear la organización debe tener un token de identidad, el cual se suministra vía email. Guarda la información de la organización y del usuario cuando una identidad la registra por primera vez en el sistema.

Codigos de Error

Code	Cause	Status	Message
`117`	No puede ingresar porque no llego el token	`401`	NOT_AUTHORIZED
`118`	El token expiro su tiempo de vida	`408`	EXPIRE_TOKEN
`119`	El token es incorrecto	`401`	TOKEN_INVALID
`120`	La organización no se puede crear	`404`	NO_ORGANIZATION_CREATE
`121`	El usuario no puede ser creado	`404`	NO_USER_CREATE
`160`	No se pudo encontrar la organización	`404`	NO_IDENTITY_NO_FOUND
`161`	No se puede crear el usuario	`404`	NO_USER_CREATE
`162`	No existe la identificación de la organización	`301`	NO_EXIST_ORGANIZATION
`163`	El usuario no fue encontrado	`301`	NO_EXIST_USER

Buscar Organización

Información

Tip

{url}¹/v1/identity/identity/get-companies-user

Info

Obtiene las organizaciones en la que se encuentra una identidad

Codigos de Error

Code	Cause	Status	Message
`138`	The User was not found	`404`	USER_NOT_FOUND
`139`	Failed to get users companies	`500`	CATCH_FUNCTION

Cambiar Organizaciones

Información

Tip

{url}¹/v1/identity/identity/send-companies-user

Info

Me da el Token de organización con el que trabajare con los assets nuevos. Gives the organization Token with which the user is going to work

Codigos de Error

Code	Cause	Satus	Message
`140`	The User was not found	`400`	USER_NOT_FOUND
`141`	The Organization was not found	`400`	NO_EXIST_ORGANIZATION
`142`	Failed to send users companies	`500`	CATCH_FUNCTION

Obtener Usuarios de Organizacion

Información

Tip

{url}¹/v1/identity/organization/get-company-users

Info

API Para consultar los usuarios ligados a la organización. La organización se obtiene mediante el token de 'Authorization'

Codigos de Error

Info

Falta

Obtener Listado de Paises

Información

Tip

{url}¹/v1/identity/identity/get-countries

Info

Lista los países que se encuentra dentro de la BD actualmente, el cual muestra los códigos de cada país. Debe agregar el token en el Header.

Codigos de Error

Code	Cause	Status	Message
`414`	The countries was not found	`404`	COUNTRIES_NOT_FOUND

Generar Token de Invitación

Información

Tip

{url} /v1/identity/organization/generate-token-invitation

Info

Envía un email con una Url la cual se encuentra la invitación del usuario a la organización. Genera la información del usuario creado actualmente, con estado inactivo hasta que el usuario acepte la invitación.

Se requiere:

El token del usuario dentro de la organización.
El email del usuario al cual le van hacer la invitación.
Tipo de identificación: Tipo de identificación del usuario dentro de la organización. Si es cédula se debe poner(ID) si es N. pasaporte (PA).
Identificación: Numero de identificación de usuario que se va a enviar la invitación.

Codigos de Error

Code	Cause	Status	Message
`125`	The user cannot be created	`404`	NO_USER_CREATE
`136`	The users was not found	`404`	USER_NOT_FOUND
`154`	The user was not edited	`404`	NO_EDIT_USER
`424`	The email is registered with another identification	`401`	EMAIL_WITH_ANOTHER_IDENTIFICATION
`425`	This user is active in the organization	`401`	USER_ACTIVE_IN_ORGANIZATION
`426`	No set email in the request	`400`	NO_EMAIL
`427`	No valid email	`400`	NO_VALID_EMAIL
`428`	No set number identification in the request	`400`	NO_IDENTIFICATION
`429`	No set country in the request	`400`	NO_COUNTRY
`430`	No set Type Identification in the request	`400`	NO_TYPE_IDENTIFICATION
`431`	The countries were not found	`400`	COUNTRY_NOT_FOUND

Directorios

Info

Proceso de creación de directorios ARKDIA BlockChain

Headers

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Body

KEY	VALUE
name:	dado por el usuario
tags:	dados por el usuario

Crear Directorio de Documento

Tip

Método: POST.
URL: {url}/v1/bpo/config/directory

La información se envía usando Headers y Body de la petición
Los parámetros que van dentro del Headers son:

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Los parámetros que van dentro del Body son:

Metodo raw

KEY	VALUE
name:	dado por el usuario
tags:	dados por el usuario

Api para guardar y clasificar contratos

Code	Cause	Status	Message
`300`	No se ha encontrado el nombre	`401`	NAME_NOT_FOUND
`301`	La solicitud no se ha procesado correctamente, catch function	`500`	CATCH_FUNCTION
`302`	No se ha encontrado la organización	`400`	NO_ORGANIZATION_FOUND

Obtener Lista Directorios

Info

Obtiene una lista de los directorios creados en la organización, por defecto tiene el directorio "general".
Directorio "general": Es un directorio que se crea por defecto para todas las organizaciones, su función es permitir subir/adjuntar un archivo.

Método: GET.
URL: {url}/v1/bpo/config/directory
La información se envía usando Headers de la petición
Los parámetros que van dentro del Headers son:

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Api to GET Directory

Code	Cause	Status	Message
`324`	There are no created directories yet	`404`	DIRECTORIES_NOT_FOUND
`325`	Request has not been processed correctly, catch function	`500`	CATCH_FUNCTION

Patrones

Proceso de selección de Patrones ARKDIA BlockChain

Headers

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Listar Patrones

Info

Obtiene una lista de los Patrones creados en la organización, por defecto tiene los Patrones "General, Subir Documento".

Método: GET.
URL: {url}/v1/bpo/config/pattern
La información se envía usando Headers de la petición
Los parámetros que van dentro del Headers son:

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Api to GET Patterns

Code	Cause	Status	Message
`306`	There are no created patterns yet	`404`	PATTERNS_NOT_FOUND
`307`	Request has not been processed correctly, catch function	`500`	CATCH_FUNCTION

Documentos

Proceso de creación de documentos ARKDIA BlockChain

* Parámetros

Headers

KEY	VALUE
Authorization	“Bearer” + ”Espacio” + token

Body

KEY	VALUE
file:	buscar documentos para adjuntar
name:	dado por el usuario
kind:	API
pattern:	ID dado en punto 3
directory:	ID dado en punto 2
metaObject:	"[]"
address:	Direccion
SignersList:	Datos de Firmantes (entre {} va la informacion de cada firmante )

Crear Documentos

Tip

{url}/v1/bpo/asset/asset-api

Info

Crea y envía los documentos a los firmantes para su respectiva revisión y firma del documento

ESTADOS DISPONIBLES DEL DOCUMENTO

0 => EN PROCESO - Estado necesario para editar o archivar un documento

1 => EN APROBACION - Estado posterior a la creacion/edicion de un documento

2 => EN PROCESO DE FIRMA - Estado posterior a la realizacion de la firma de un usuario ligado al documento

3 => FIRMADO - Estado cuando todas las firmas del documento se han realizado

ESTADOS DISPONIBLES BLOCKCHAIN

0 => NO CREADO - Estado inicial del cualquier documento que indica que el documento actual no esta listo para registrarse en la Red Blockchain

1 => LISTO PARA REGISTRAR - Estado que indica cuando el documento esta listo para ser cargado a la red Blockchain

2 => REGISTRADO EXITOSAMENTE - Estado que indica que el documento ha sido registrado exitosamente en la red de Blockchain

Warning

El campo 'responsible' corresponde al usuario que quedara a cargo del documento para recibir notificaciones del documento. En caso de no diligenciarse este campo se guardara automaticamente con el creador por defecto. Si se desea agregar un responsable personalizado, en este campo se debe ingresar la identidad del usuario de la organizacion. Para consultar este dato pueden consultar la siguiente API: Creacion organizaciones y cuenta => (GET) Obtener Usuarios de Organizaciones Y en el resultado deberian obtener el campo identity, tomar _id de respectivo objeto.

Codigos de error

Code	Cause	Status	Message
`327`	The name has not been found	`400`	NO_NAME_FOUND
`328`	The directory has not been found	`400`	NO_DIRECTORY_FOUND
`329`	The pattern has not been found	`400`	NO_PATTERN_FOUND
`330`	The asset has not been created	`400`	NO_FILE_FOUND
`331`	The asset has not been created	`400`	NO_USER_FOUND
`332`	The asset has not been created	`400`	NO_ASSET_CREATE
`333`	The pdf html has not been convert	`400`	NO_CONVERT_PDF_HTML
`334`	The merge has not been merge	`400`	NO_MERGE_ASSET
`335`	The pdf html has not been convert	`400`	NO_CONVERT_PDF_HTML
`336`	The asset has not been created	`400`	NO_ASSET_CREATE
`337`	The first name has not be found	`400`	NO_FIRST_NAME_FOUND
`338`	The last name has not be found	`400`	NO_LAST_NAME_FOUND
`339`	The identification has not be found	`400`	NO_IDENTIFICATION_FOUND
`340`	The identification kind has not be found	`400`	NO_IDENTIFICATION_KIND_FOUND
`341`	The email has not be found	`400`	NO_EMAIL_FOUND
`342`	The country has not be found	`400`	NO_COUNTRY_FOUND
`343`	The address has not be found	`400`	NO_ADDRESS_FOUND
`344`	The asset has not been created	`400`	NO_ENDORSEMENT_CREATE
`345`	The asset has not been update	`400`	NO_UPDATE_ASSET
`346`	The version has not been created	`400`	NO_VERSION_CREATE
`347`	The asset has not been found	`400`	NO_EXIST_ASSET
`348`	The version has not been found	`400`	NO_EXIST_VERSION
`349`	The version has not been found	`400`	NO_VERSION_CREATE
`350`	The pdf html has not been convert	`400`	NO_CONVERT_PDF_HTML_UPDATE
`351`	The asset has not been merge	`400`	NO_MERGE_ASSET_UPDATE
`352`	The pdf html has not been convert	`400`	NO_CONVERT_PDF_HTML
`353`	The version has not been found	`400`	NO_VERSION_CREATE
`354`	The asset has not been update	`400`	NO_ASSET_UPDATE
`355`	The first name has not be found	`400`	NO_FIRST_NAME_FOUND
`356`	The last name has not be found	`400`	NO_LAST_NAME_FOUND
`357`	The identification has not be found	`400`	NO_IDENTIFICATION_FOUND
`358`	The identification kind has not be found	`400`	NO_IDENTIFICATION_KIND_FOUND
`359`	The email has not be found	`400`	NO_EMAIL_FOUND
`360`	The country has not be found	`400`	NO_COUNTRY_FOUND
`361`	The address has not be found	`400`	NO_ADDRESS_FOUND
`362`	The endorsement has not been created	`400`	NO_ENDORSEMENT_CREATE
`363`	The asset has not been updated	`400`	NO_UPDATE_ASSET
`364`	Request has not been processed correctly, catch function	`500`	CATCH_FUNCTION

En {url} va el entorno de desarrollo de donde este utilizando Arkdia. Ej: https://app.arkdia.co/... ↩↩↩↩↩