POPBill Developers
Guide
NTS Crawling
Guide Getting Started API Integration

API Integration

Our service independently operates each TEST and PRODUCTION stages. We support the integration development by providing a TEST stage that operates the same functions as the PRODUCTION and has an identical condition as the actual service.

  • Independent development environment
  • Identical authentication information (LinkID, SecretKey) is used in both stages
  • Free test point (some restrictions apply)

Steps for Integration

  1. Application for integration : apply with a client’s business information.

    Followings are required information to enter for a development testing :

    1. 1) Company information– business registration number, company name, CEO name, industry of business, items of business, address
    2. 2) Account Information – ID, PW
      • POPBiLL service website(both TEST and PRODUCTION) accounts are generated with the entered information.
      • ID information cannot be modified once it is generated. Please register an account with information on behalf of a company, not an individual.
    3. 3) Person in charge information – name, email, contact number
  2. Set API Key : set it on an SDK file. [SDK Preference]

    A client will receive API Key after an application is submitted. Set information on an SDK to use POPBiLL API service.

    • LinkID : unique identification information to distinguish a client and it is used for client management such as account registration.
    • SecretKey : information that is used to prevent a forgery of an API communication protocol.

    Please do not expose an authentication information to any external sources as it contains unique information to distinguish a client.

  3. Development Test : Development Test : no monthly payment for the first 1-month to support the development testing.

    You can test all the API services with the SDK file (registered with the provided API key) along with API documentation. Be aware that the actual sales/purchase data will be crawled from the NTS server within the TEST stage. If you need to test for longer than a month, please contact the partner service center.

    If you need to test with different company information other than the initially entered one from the integration application, please contact the partner service center.

  4. Go-live request for PRODUCTION stage : you can immediately use the service on the day of the request for go-live
    1. 1) Once a test is completed, request a go-live to PRODUCTION stage.
    2. 2) For a go-live process, please contact the partner center to discuss about information.
    3. 3) After receiving the email on completion of a go-live, change the variable for SDK configuration setting.

      - You do not need to request for API Key for production setting. The initial information provided for the TEST stage identically applies to the PRODUCTION stage.

      - You can use both stages by simply changing a value(true/false) of IsTest variable on the SDK config.

      How to change SDK configuration setting?

      Change the IsTest value of the config(creates a service object of SDK) from “true” (TEST) to “false” (PRODUCTION). [SDK Preference]

    4. 4) Proceed with the account registration for PRODUCTION stage and preliminary preparation (registering API key within the SDK, service fee payment, etc.) to use the actual service.

    As the TEST stage is independently constructed from the PRODUCTION, any registered certificate and account cannot be transferred between the different stages.