Documentación - Integración

Tocapu API

Esta API REST te permitirá subir documentos, crear carpetas y proyectos.

Tocapu API V1

Tocapu API

Ponemos a tu disposición esta API-REST que te permitirá integrar tu aplicación muy rapidamente.

 


Autenticación

Para poder empezar a usar la aplicación necesita una RUTA y un TOKEN.

Una vez que tengas tu cuenta de PAGO busca la opción “Autenticación”, esta es una manera de proteger Tocapu de accesos no autorizados.

Ejemplos:

  • RUTA: https://api.tocapu.pe/api/v1/t82fxQ3XRf 
  • TOKEN: eyJhbGciOiJIUzI1NiJ9

Enviar a la RUTA una solicitud POST, incluir en “Authorization” de la cabecera (Header) el Token, junto con un Content-Type.

--METHOD
POST

--HEADER
Authorization     ENVIAR_TOKEN_AQUI
Content-Type      application/json

--BODY
{"operacion": "subir_documento", Etc...}

Adjuntar en el CUERPO o BODY el archivo JSON de la solicitud.

IMPORTANTE: Todas las solicitudes que se hacen a la RUTA son con el método POST. No olvides reemplazar ENVIAR_TOKEN_AQUI con tu TOKEN.

Herramientas recomendadas:

Algunas herramientas que podrían ser de utilidad son:

Si necesitas ayuda no dudes en enviarnos un ticket desde https://ayuda.llama.pe/ticket.

 


Operaciones

Las operaciones o métodos disponibles son los siguientes.

crear_carpeta [POST]

crear_carpeta

Este método permite crear carpetas en la plataforma de Tocapu.pe

RUTA: https://ayuda.llama.pe/preguntas/tocapu/integracion-api/como-crear-carpetas-por-api-02856b54-072f-496c-b877-be4e85fd9b70
MÉTODO: POST
  • JSON DE ENVÍO

    JSON de envío

    {
      "operacion": "crear_carpeta",
      "nombre": "Nueva carpeta",
      "descripcion": "",
      "destacado": false,
      "proyecto": "P2001101001"
    }

    Descripción

    ClavesValores (descripción) Tipo de dato
    operacionDebe ser “crear_carpeta”String
    nombreUn nombre de la carpetaString
    descripcionDescripción del documentoText
    destacadoPrioridad de la carpetaBoolean
    proyectoPara anexar el proyecto que tienes creadoString
  • JSON DE RESPUESTA

    JSON de respuesta

    {
      "success": true,
      "mensaje": "Carpeta creada correctamente",
      "codigo": "C2001101001"
    }

    Descripción

    AtributoDescripción
    successSiempre será true.
    mensajeMensaje de respuesta.
    codigoCódigo de la solicitud.

subir_archivo [POST]

subir_archivo

Este método permite subir archivos en la plataforma de Tocapu.pe

RUTA: https://ayuda.llama.pe/preguntas/tocapu/integracion-api/como-subir-archivos-por-api-b44ce075-8a2c-4d35-a0c1-5201979a683a
MÉTODO: POST
  • JSON DE ENVÍO

    JSON de envío

    {
      "operacion": "subir_archivo",
      "carpeta": "C200206007",
      "nombre": "archivo1.pdf",
      "descripcion": "",
      "forzar": false,
      "archivo": "ZIPbase64",
      "entity": {
        "documento_tipo": "1",
        "documento_numero": "20553510661",
        "denominacion": "LLAMA.PE SA",
        "razon_comercial": "",
        "direccion": "",
        "telefono": "",
        "email": "",
        "email_2": "",
        "email_3": ""
      }
    }

    Descripción

    ClavesValores (descripción) Tipo de dato
    operacionDebe ser “subir_archivo”String
    carpetaCódigo de la carpetaString
    nombreNombre de la carpetaString
    descripcionDescripción de la carpetaText
    forzarReemplazar la solicitud. Para reemplazar la solicitud, debe estar en true.Boolean
    archivoArchivo pdf zipeado en base64.Array
    documento_tipoTipo de identificación (RUC, DNI, CE, Pasaporte, etc)Array
    documento_numeroNúmero de identificaciónArray
    denominacionNombre de la identificación Array
    razon_comercialSi es RUC, el nombre de la razón comercial (opcional)Array
    direccionDirección fiscal de identificaciónArray
    telefonoNúmero de teléfonoArray
    emailCorreo electrónicoArray
  • JSON DE RESPUESTA

    JSON de respuesta

    {
      "success": true,
      "mensaje": "Archivo subido correctamente",
      "nombre": "archivo1.pdf",
      "codigo": "A200201001"
    }

    Descripción

    AtributoDescripción
    successSiempre será true.
    mensajeMensaje de respuesta.
    nombreNombre del documento.
    codigoCódigo de la solicitud.

crear_proyecto [POST]

crear_proyecto

Este método permite crear proyectos en la plataforma de Tocapu.pe

RUTA: https://ayuda.llama.pe/preguntas/tocapu/integracion-api/como-crear-proyectos-por-api-9eae3e0a-6b88-4ea7-aa8a-df316108ed48
MÉTODO: POST
  • JSON DE ENVÍO

    JSON de envío

    {
      "operacion": "crear_proyecto",
      "nombre": "Nuevo proyecto",
      "descripcion": "",
      "destacado": false
    }

    Descripción

    ClavesValores (descripción) Tipo de dato
    operacionDebe ser “crear_proyecto”String
    nombreUn nombre del proyectoString
    descripcionDescripción del proyectoText
    destacadoEtiquetar el proyecto como prioritarioBoolean
  • JSON DE RESPUESTA

    JSON de respuesta

    {
      "success": true,
      "mensaje": "Proyecto creado correctamente",
      "codigo": "P2001101001"
    }

    Descripción

    AtributoDescripción
    successSi esta conforme, sera true
    mensajeMensaje de respuesta.
    codigoCódigo de la solicitud.


Manejo de errores

Los errores de la aplicación responden de la siguiente manera.

{
  "error": "El dato ingresado no es correcto"
}

Los errores se describen en el campo "error".

Recordar que las respuestas también incluyen en la cabecera códigos http:

  • 400 – Bad Request.
  • 401 – Authorization Required.
  • 403 – Forbidden.
  • 404 – Not Found.
  • 500 – Internal Server Error.
  • 502 – Bad Gateway.
Cargando imagen...

Cargando imagen...

Previsualización

Cargando pdf...
Descargar PDF