inputFile (File Filter)
    • PDF

    inputFile (File Filter)

    • PDF

    Article Summary

    Overview

    • The inputFile API is a feature provided by "File Filter" in "File Safer" and is an API sending files for analysis.
    • You can use this API through IAM authentication and API Gateway used in NAVER Cloud Platform.

    Requests

    MethodRequest URI
    POSThttps://filesafer.apigw.ntruss.com/filefilter/v1/inputFile
    FormatMultipart-form

    Request headers

    Header nameDescription
    x-ncp-apigw-timestampTime elapsed in milliseconds since January 1, 1970, 00:00:00 UTC
    If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid
    x-ncp-apigw-api-keyKey issued from API Gateway
    x-ncp-iam-access-keyAPI Key issued from NAVER Cloud Platform or AccessKey issued from IAM
    x-ncp-apigw-signature-v2A signature that encrypts the request path and header with a SecretKey mapped to an AccessKey
    HMAC encryption algorithm uses HmacSHA256

    See Call API that requires IAM authentication
    acceptIndicate json
    application/json
    Content-TypeIndicates that it is multipart
    multipart/form-data

    Request parameters

    Parameter nameRequirement statusTypeDescription
    fileYesfileFile requested for analysis (file to be sent)
    archivePasswordNostringArchive password

    Responses

    Response bodies

    Field nameRequirement statusTypeDescription
    returnCodeYesstringProcessing result code for requests
    returnMessageYesstringProcessing result message for requests

    Examples

    Request examples

    curl -X POST "https://filesafer.apigw.ntruss.com/filefilter/v1/inputFile"
       -H "accept: application/json"
       -H "Content-Type: multipart/form-data"
       -H "x-ncp-apigw-api-key: {x-ncp-apigw-api-key}"
       -H "x-ncp-iam-access-key: {x-ncp-iam-access-key}"
       -H "x-ncp-apigw-timestamp: {x-ncp-apigw-timestamp}"
       -H "x-ncp-apigw-signature-v2: {x-ncp-apigw-signature-v2}"
       -d {"archivePassword":{password},"file":{binary}}
    

    Response examples

    {
      "returnCode": "0",
      "returnMessage": "success"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.