Tutoriales
Descripción de Tutoriales
Organizaciones
Crear Organizaciones
Info
Api para crear organización
Entramos a Postman en la api Crear Organizacion
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
1) businessName , Razon social de la organización.
2) tributaryNumber , Identificacion de la organización.
3) country , Abreviativo3 del pais.
4) email , email de la organización.
5) phone , telefono de la organización.
6) address , dirección de la organización.
7) webSite , sitio web de la organización.
8) constitutionDate , fecha de constitución de la organización.
Buscar Organizaciones
Info
Api para obtener el detalle de la organización
Entramos a Postman en la api Buscar Organizacion
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Obtendremos el detalle de nuestra organización.
Cambiar Organizacion
Info
Falta Detalle
Entramos a Postman en la api Cambiar Organizacion
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
1) organization , Id de Organizacion dada por API 0.1
Obtener Usuarios de Organizacion
Info
Con esta API obtendremos el listado de usuarios de nuestra organización, con detalle de los mismos
Entramos a Postman en la api Cambiar Organizacion
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud obtendremos el listado de todos los usuarios registrados en nuestra organización con detalle.
Obtener Listado de Paises
Info
Con esta API obtendremos el listado de paises con detalle regitrados en Arkdia
Entramos a Postman en la api Lista los Paises
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud obtendremos el listado de todos los paises registrados con detalle.
Generar Token de Invitación
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.
Entramos a Postman en la api Generar Token de Invitación
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
1) country Es el codigo del país3. Existe un api que muestra los codigos de los paises
2) email Email al usuario que se va enviar la invitación
3) email Email al usuario que se va enviar la invitación
4) identificationKind Tipo de identificación si es cedula(ID) si es N. pasaporte (PA)
4) identification Numero de identificación de usuario que se va a enviar la invitación.
Directorios
Crear Directorio de Documento
Info
Con esta API crearemos un directorio para nuestros documentos en Arkdia
Entramos a Postman en la api Crear Directorio de Documento
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud registraremos un directorio en nuestra organización.
1) name , Nombre del directorio
2) tags , Etiqueta que identifica el tipo de tema que trata el directorio
Obtener Lista Directorios
Info
Con esta API obtendremos los directorios a detalle registrados en la organización
Entramos a Postman en la api Obtener Lista Directorios
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud obtendremos el listado de todos los directorios registrados en la organización.
Patrones
Listar Patrones
Info
Obtenemos el listado de Patrones que tenemos en la Organización, los patrones son los tipos de documentos que podemos subir a la plataforma.
Entramos a Postman en la api Listar Patrones
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Damos Click en Send y obtendremos todo el listado de patrones registrados en la organización. El id del patron lo usaremos otras apis, es indispensable para la creación y actualización de nuestros documentos.
Documentos
Crear Documentos
Info
Crea y envía los documentos a los firmantes para su respectiva revisión y firma del documento.
Entramos a Postman en la api Crear Documentos
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Damos Click en Send se registrará el archivo en Arkdia y enviaremos el archivo a los respectivos firmates.
1) file Campo donde se adjunta el archivo pdf
2) name Coloca el nombre del archivo
3) kind Coloca el tipo de documento
4) pattern Coloca el ID1 del patron del documento
5) directory Coloca el ID2 del directorio del documento
6) metaObject Campo donde se agrega el metaObject, preferiblemente usar la plataforma.(No obligatorio via Api)
7) signersList Campo donde se agregan los firmantes del documento.
8) responsible Campo donde se agrega el responsable del documento. (No obligatorio via Api)
Listar Documentos y sus Progresos
Info
Obtenemos el listado de documentos especificos segón los filtros ingresados
Entramos a Postman en la api Listar Documentos y sus Progresos
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Modificar Documentos
Info
Api para modificar documentos, envía los documentos a los firmantes para su respectiva revisión y firma del documento.
Entramos a Postman en la api Modificar Documentos
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Warning
Agregaremos despues de la ruta el id 4 del documento asi:
{url}/v1/bpo/asset/asset-api/{idDocumento4}
Info
Damos Click en Send se modificara el documento en Arkdia y enviaremos el archivo a los respectivos firmates.
1) file Campo donde se adjunta el archivo pdf
2) name Coloca el nombre del archivo
3) kind Coloca el tipo de documento
4) pattern Coloca el ID1 del patron del documento
5) directory Coloca el ID2 del directorio del documento
6) metaObject Campo donde se agrega el metaObject, preferiblemente usar la plataforma.(No obligatorio via Api)
7) signersList Campo donde se agregan los firmantes del documento.
8) responsible Campo donde se agrega el responsable del documento. (No obligatorio via Api)
Archivar Documentos
Info
Api para archivar documentos, este proceso se realiza por si el documento no es necesario para la organización y no requirió firma. Entramos a Postman en la api Archivar Documentos
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Damos Click en Send se archivará el documento y no se contará como un documento activo
1) id Id4 del Archivo
2) archive Campo predeterminado en 1 para la solicitud de archivar
3) status Campo predeterminado en 0 cambiara el estado del documento para poder archivar
Firmantes de Documento
Info
Api para obtener los firmantes de un documento en especifico. Entramos a Postman en la api Firmantes de Documento
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Versiones del Documento
Info
Api para obtener las versiones a detalle de un documento en especifico. Entramos a Postman en la api Versiones del Documento
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Descargar Documento
Info
Api para descargar una version de un documento en especifico. Entramos a Postman en la api Descargar Documento
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Detener Documento
Info
Api para detener el proceso del documento y habilita la opción de modificar o archivar dicho documento. Entramos a Postman en la api Detener Documento
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud el documento se habrá detenido y podemos proceder a Modificar o Archivar el documento.
1) asset , Id4 del documento a detener.
Reenviar invitacion de Firma
Info
Api para reenviar el correo para la firma o aval de un documento en especifico a un firmante en especifico. Entramos a Postman en la api Reenviar invitacion de Firma
Warning
En el parametro Authorization pasamos como valor nuestro token de usuario junto con la palabra Bearer al principio del token;
Info
Al enviar la solicitud al firmante le llegará nuevamente el correo de firma con un plazo de 3 diás para realizarla.
1) assetId , Id4 del documento.
2) identification , identificación del firmante.
-
El id del patron lo obtendremos en la api Listar Documentos ↩↩↩
-
El id del directorio lo obtendremos en la api Obtener Lista Directorios ↩↩↩
-
El abreviativo del pais lo obtendremos en la api Listar Paises ↩↩
-
El Id del Documento lo obtendremos en la respuesta al crear un documento en la api Crear Documento , el campo _id ↩↩↩↩↩↩↩↩↩
-
El Id de la versión del documento lo obtendremos en la respuesta al consultar las versiones de un documento en la api Versiones del Documento , el campo _id ↩↩
-
La identificación del firmante la podemos encontrar en la respuesta de la api: Firmantes de Documento , el campo identification. ↩